Overview
You can call this API to enable a tenant to connect to a private link.
Note
This API is not supported for Alibaba Cloud instances.
API details
Constraints
The caller must have an AccessKey for accessing APIs of multi-cloud services. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/tenants/{tenantsId}/privatelink/service
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**** |
| userAccount | String | Yes | The user account. | user123 |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| addressId | string | The ID of the address. | rs-private-intranet-vpc-XXXXXX-OBPROXY-INTRANET-XXXXXX |
| requestId | string | The ID of the request. | e448d60c-****-****-****-d33295124beb |
| success | string | Indicates whether the operation was successful. Valid values: |
true |
Examples
Request example
curl --digest -u 'ak:sk' \
--request POST \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"userAccount": "xxxxx" }' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantsId}/privatelink/service'
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":{
"addressId":"rs-private-intranet-vpc-XXXXXX-OBPROXY-INTRANET-XXXXXX"
},
"requestId":"e448d60c-****-****-****-d33295124beb",
"success":true
}