DeleteInstances - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to release an OceanBase cluster.

Operation description

Before you call this operation, ensure that the following requirements are met:

The cluster is in the Running state.
The cluster is a primary cluster and the billing method is pay-as-you-go.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DeleteInstances	Write	Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	string	Yes	The ID of the cluster to be deleted. The value is a string in the JSON format.	[”ob ob3f6yhv9uxxxx“]
BackupRetainMode	string	No	The backup retention strategy for cluster deletion. Valid values: receive_all: retains all backup sets. delete_all: deletes all backup sets. receive_last: retains the last backup set. Note Default value: delete_all.	delete_all
DryRun	boolean	No	Specifies whether to perform only a dry run for the request. Default value: false. Valid values: true: Only a dry-run request is sent and the instance is not deleted. If the dry run succeeds, DryRunResult=true is returned. If the dry run fails, an error code is returned. false: The actual request is sent and no dry run is performed. The instance is deleted if the requirements are met. By default, false is returned for the parameter DryRunResult if you set DryRun to false.	false

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	473469C7-**-**-B3DB-A3DC0DE3C83E
Data	object	The returned data.
DryRunResult	boolean	The result of the dry-run request. If the DryRun parameter is set to true and the dry run succeeds, the DryRunResult parameter returns true. Otherwise, an error code is returned. If the DryRun parameter is set to false, no dry run is performed and the DryRunResult parameter returns false.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-****-****-B3DB-A3DC0DE3C83E",
  "Data": {
    "DryRunResult": false
  }
}

Error codes

HTTP status code	Error code	Error message
400	BadRequest	BadRequest
404	InstanceStatus.Invalid	InstanceStatus.Invalid
404	StandbyInstance.StillOnline	StandbyInstance.StillOnline
404	UnknownError	UnknownError
404	Tenant.StillOnline	Tenant.StillOnline
404	ServiceTemporarilyUnavailable	ServiceTemporarilyUnavailable
404	NotFound	NotFound
500	InternalServerError	InternalServerError

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-10-30

The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: DryRun
Output Parameters	The response structure of the API has changed.

2023-07-04

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Added Error Codes: 400
	Added Error Codes: 404
	Added Error Codes: 500