Overview
You can call this API to add a user to the allowlist of the PrivateLink service for a tenant. This allows the specified account to access the private network service of the tenant, enhancing access control and security.
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.
Currently, the allowlist is open. If you need to use it, please contact technical support.
Request path
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/user
Request parameters
| 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. | t33h8y08k**** |
| requestId | String | Yes | The request ID, used for tracking. | dc302d76-66b5-48d8-ab53-a035******** |
| userAccount | String | Yes | The user account. | user123 |
| addressId | String | Yes | The ID of the address. | rs-praivate-******** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| requestId | string | The request ID. | 167140a8-****-****-9ca1c646ae25 |
| success | string | Indicates whether the query was successful. Valid values: |
true |
Examples
Request example
curl --digest -u '<your ak:sk>' \
--request POST \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'Content-Type: application/json' \
--data '{"userAccount": "user123", "addressId": "rs-praivate-********"}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/user?requestId={requestId}'
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":"167140a8-****-****-****-9ca1c646ae25",
"success":true
}