调用DeleteInstances释放OceanBase实例_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

调用接口释放 OceanBase 实例。

接口说明

调用该接口时，实例必须满足以下条件，否则将操作失败：

当前API暂无授权信息透出。

名称	类型	必填	描述	示例值
InstanceIds	string	是	需删除的集群 ID。格式为 JSON 数组的字符串。	["ob317v4uif**","ob627v4uif**"]
BackupRetainMode	string	否	集群删除后的备份保留策略。取值如下： receive_all：保留全部备份集; delete_all：删除全部备份集； receive_last：保留最后一个备份集。说明默认值为 delete_all。	delete_all
DryRun	boolean	否	是否只预检此次请求, 默认为 false。取值范围： true：发送检查请求，不会删除实例。如果检查通过，则返回 DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。 false（默认）：发送正常请求，通过检查后直接删除实例。如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。	false

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	返回数据。
DryRunResult	boolean	预检查请求的结果。如果 DryRun 填写为 true，当预检查请求通过，则 DryRunResult 返回 true，否则返回相应的错误码信息。如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。	false

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "DryRunResult": false
  }
}

HTTP status code	错误码	错误信息
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

访问错误中心查看更多错误码。

变更时间	变更内容概要	操作
2023-10-30	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-04	OpenAPI 错误码发生变更	查看变更详情