Overview
You can call this API to delete an OceanBase cluster instance.
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
Request parameters
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| None |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | Integer | Yes | The ID of the instance. | ob677efwh8****** |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| success | Boolean | Indicates whether the request is successful. | true or false |
| requestId | String | The ID of the request. | dc302d76-66b5-48d8-ab53-a035****** (64-bit) |
Examples
Request example
curl --request DELETE \
--digest -u 'ak:sk' \
--data '{"instanceId":"ob677efwh8********"}' \
--url https://api-cloud.oceanbase.com/api/v2/instances
-H 'X-Ob-Project-Id: Project ID'
Note
A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
Response example
Here is a response example when the request is successful:
{
"data":{},
"success" : true,
"requestId": "dc302d76-66b5-48d8-ab53-a035********"
}
Here is a response example when the request failed:
{
"errorCode": "Privilege.OpenAPI.AuthFailed",
"errorMessage": "OpenAPI authentication failed",
"requestId": "cb32942e-bdf2-4d85-a26f-6bf8********",
"success": false
}
