Overview
You can call this API to delete a tenant address.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}/address
Request parameters
Path
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | string | Yes | The ID of the tenant. | ob2mr3oae0**** |
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| addressId | String | Yes | The ID of the address | rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2bg2o-**** |
| requestId | String | Yes | The ID of the request | 6e87d618-854e-4ca1-ae1f-babc******** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| success | boolean | Indicates whether the operation succeeded. | true/false |
| errorCode | string | The error code. | "E001" |
| errorMessage | string | The error message. | "Operation succeeded" |
| data | boolean | The business data. | {...} |
| data.addressId | string | The ID of the address. | "12345" |
| cost | integer[int64] | The time consumed (in milliseconds) | 150 |
| server | string | The server address | "xx.xxx.xx.xxx" |
| requestId | string | The ID of the request | "req_20250811_001" |
| totalCount | integer[int64] | The total number. | 100 |
| extra | object | The additional information. | {"key1": "value1"} |
Examples
Request example
curl --digest -u 'ak:sk' \
--request DELETE \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address'\
-H 'X-Ob-Project-Id: <Project ID>'\
-G -d 'addressId=xxx'
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": "6e87d618-854e-4ca1-ae1f-babcffd70000",
"success": true
}