Applicability
Deleting a database from a standby instance is not supported in the current version.
Overview
You can call this API to delete one or more databases.
Notice
After this operation is successfully called, the databases will be immediately removed from the system. Please make sure that the database is no longer in use to avoid affecting business operations.
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}/databases
Request parameters
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | No | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | String | Yes | The ID of the tenant. | ob2mr3oae0**** |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | No | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | String | Yes | The ID of the tenant. | ob2mr3oae0**** |
| databaseNames | String | Yes | The list of database names. It is a JSON array. Each object in the array is a database name. | ["d1", "d2"] |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| success | Boolean | Indicates whether the specified one or more databases are successfully deleted. | true |
Examples
Request example
curl -v --request DELETE \
--digest -u 'ak:sk' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/databases' \
-H 'X-Ob-Project-Id: <Project ID>'
--data \ '{"instanceId":"ob4ioyiw82yhuo","tenantId":"t4ismze9nltds","databaseNames":["default_database"]}'
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
{
"success":true
}