Overview
You can call this API to connect to the database through the endpoint of PrivateLink.
Note
This API is not supported for Alibaba Cloud instances.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. 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/connection
Request parameters
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | String | Yes | The ID of the tenant. | t33h8y08k**** |
| endpointId | String | Yes | The client ID. | t33h8y08k**** |
| addressId | String | No | The endpoint ID. In read-only scenarios, this parameter is required. | obe-4tw51gp7**** |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| requestId | string | The request ID. | ecf10c08-****-****-8a2e57897f74 |
| success | string | Whether the connection is successful. Valid values: |
true |
Examples
Request example
curl --digest -u 'ak:sk' \
--request POST \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"endpointId": "xxxxx","addressId":"xxxxx" }' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/connection'
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":{},
"requestId":"ecf10c08-****-****-****-8a2e57897f74",
"success":true
}
