Overview
You can call this API to confirm the completion of the Private Link connection.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/confirmation
Request parameters
Path
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the OceanBase Cloud instance. | ob317v4uif**** |
| tenantId | string | Yes | The ID of the tenant. | ob2mr3oae0**** |
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | String | Yes | The request ID | 6e87d618-854e-4ca1-ae1f-babc******** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| endpointId | String | Yes | The endpoint ID. | |
| addressId | String | No | The VIP service group name, which is optional. | |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| success | boolean | Indicates whether the operation succeeded. | true/false |
| errorCode | string | The error code. | "E001" |
| errorMessage | string | The error message. | "Operation succeeded" |
| data | boolean | The business data. | {...} |
| data.addressId | string | The VIP service group name. | "12345" |
| cost | integer[int64] | The time consumed (in milliseconds) | 150 |
| server | string | The server address | "xx.xxx.xx.xxx" |
| requestId | string | The request ID | "req_20250811_001" |
| totalCount | integer[int64] | The total number. | 100 |
| extra | object | The additional information. | {"key1": "value1"} |
Examples
Request example
curl --digest -u '<your ak:sk>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/confirmation?requestId={requestId}' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"endpointId": "{endpointId}", "addressId": "{addressId}"}'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
JSON format
{
"data": true,
"requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}