Overview
You can call this API to delete the PrivateLink endpoint of a tenant. After the endpoint is deleted, the related private network connection will no longer be available.
Note
This API cannot be called for Alibaba Cloud instances.
API details
Constraints
The caller must have an AccessKey for accessing multi-cloud APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink
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 for tracking. | dc302d76-66b5-48d8-ab53-a035******** |
| addressId | String | Yes | The ID of the endpoint. | rs-private-internet-***** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| requestId | string | The request ID. | 9edccdd5-****-****-****-1efcead6cd59 |
| success | string | Indicates whether the deletion operation is successful. Valid values: |
true |
Examples
Request example
curl --digest -u '<your ak:sk>' \
--request DELETE \
-H 'X-Ob-Project-Id: <Project ID>' \
'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": true,
"requestId": "9edccdd5-****-****-****-1efcead6cd59",
"success": true
}