Overview
You can call this API to query the private link address information of a tenant for VPC internal network access.
Note
This API is not supported for Alibaba Cloud instances.
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
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink
Request parameters
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | obcluster-***** |
| tenantId | String | Yes | The ID of the tenant. | t4louaeei**** |
| requestId | String | Yes | The request ID, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
| addressId | String | No | The ID of the address. | rs-private-internet-***** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | array[Object] | The list of tenant link information. | |
| data.addressId | string | The ID of the address. | rs-private-intranet-vpc-xxxxx-OBPROXY-INTRANET-xxxxxxx |
| data.addressStatus | string | The status of the address. Valid values: |
PENDING_CREATE |
| data.addressType | string | The type of the address. Valid values: |
MASTER |
| data.connectionZones | array[string] | The connection regions. | ["ap-beijing-4"] |
| data.networkType | string | The type of the address. Valid values: |
INTRANET |
| data.privateLinkEndpointId | string | The endpoint ID. | vpce-xxxxxx |
| data.privateLinkServiceAccount | string | The account ID. | 10003xxxxxx |
| data.privateLinkServiceId | string | The service ID. | vpcsvc-xxxxx |
| data.privateLinkUserAccount | string | The user account. | 10002xxxxxx |
| data.role | string | The tenant permission. Valid values:
|
READWRITE |
| data.userNameFormat | string | The format of the username. Format: USER_AND_TENANT: username@tenant name. |
USER_AND_TENANT |
| requestId | string | The request ID. | 8fb87c78---****-00b1c8e5af7b |
| success | boolean | Whether the query operation is successful. Valid values: |
true |
Examples
Request example
curl --digest -u '<your ak:sk>' \
--request GET \
-H 'X-Ob-Project-Id: {projectId}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink?requestId={requestId}&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": [{
"addressId": "rs-private-intranet-vpc-xxxxx-OBPROXY-INTRANET-xxxxxxx",
"addressStatus": "PENDING_CREATE",
"addressType": "MASTER",
"connectionZones": ["ap-beijing-4"],
"networkType": "INTRANET",
"privateLinkEndpointId": "vpce-xxxxxx",
"privateLinkServiceAccount": "10003xxxxxx",
"privateLinkServiceId": "vpcsvc-xxxxx",
"privateLinkUserAccount": "10002xxxxxx",
"role": "READWRITE",
"userNameFormat": "USER_AND_TENANT"
}],
"requestId": "8fb87c78-****-****-****-00b1c8e5af7b",
"success": true
}