Overview
You can call this API to add a user to the allowlist.
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
POST /api/v2/instances/{instanceId}/tenants/{tenantsId}/privatelink/user
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 |
| addressId | String | Yes | The ID of the IP address. | rs-praivate-******** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| requestId | string | The request ID. | 167140a8-****-****-9ca1c646ae25 |
| success | string | The value indicates whether the query operation is successful. Valid values: |
true |
Examples
Request example
curl --digest -u 'ak:sk' \
--request POST \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"userAccount": "xxxxx", "addressId": "rs-private***"}'
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantsId}/privatelink/user'
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
}