文档

DeleteInstances - 释放 OceanBase 实例

更新时间:

调用接口释放 OceanBase 实例。

接口说明

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

  • 实例状态为运行中;
  • 实例类型为主实例(按量付费类型)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oceanbase:DeleteInstancesWrite
  • Instance
    acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*

请求参数

名称类型必填描述示例值
InstanceIdsstring

需删除的集群 ID。
格式为 JSON 数组的字符串。

["ob317v4uif****","ob627v4uif****"]
BackupRetainModestring

集群删除后的备份保留策略。取值如下:

  • receive_all:保留全部备份集;
  • delete_all:删除全部备份集;
  • receive_last:保留最后一个备份集。
说明
默认值为 delete_all。
delete_all
DryRunboolean

是否只预检此次请求, 默认为 false。取值范围:

  • true:发送检查请求,不会删除实例。如果检查通过,则返回 DryRunResult=true, 如果检查不通过, 则返回相应错误的错误码。
  • false(默认):发送正常请求,通过检查后直接删除实例。如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。
false

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

返回数据。

DryRunResultboolean

预检查请求的结果。

  • 如果 DryRun 填写为 true,当预检查请求通过,则 DryRunResult 返回 true,否则返回相应的错误码信息。
  • 如果 DryRun 填写为 false, 则表示不进行预检查, DryRunResult 默认返回 false。
false

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400BadRequestBadRequest
404InstanceStatus.InvalidInstanceStatus.Invalid
404StandbyInstance.StillOnlineStandbyInstance.StillOnline
404UnknownErrorUnknownError
404Tenant.StillOnlineTenant.StillOnline
404ServiceTemporarilyUnavailableServiceTemporarilyUnavailable
404NotFoundNotFound
500InternalServerErrorInternalServerError

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

变更历史

变更时间变更内容概要操作
2023-10-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:DryRun
出参OpenAPI 返回结构发生变更
2023-07-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:404
    新增错误码:500
  • 本页导读 (0)