文档

DeleteSandboxInstance - 释放沙箱实例

释放沙箱实例。

接口说明

当前接口仅支持 DBS API 服务 2021-01-01 版本。

调试

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

授权信息

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

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

请求参数

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

备份计划 ID,您可以通过 DescribeBackupPlanList 接口获取该参数。

说明 若您的实例为 RDS MySQL,请通过自动添加数据源功能,将 RDS 自动添加至 DBS 中,即可获取备份计划 ID。
1hxxxx8xxxxxa
InstanceIdstring

沙箱实例 ID,您可以通过 DescribeSandboxInstances 接口获取该参数的值。

1jxxxxnxxx1xc
ZoneIdstring

目标沙箱实例的可用区 ID,该可用区 ID 需要是 PrivateLink 服务支持的可用区 ID。可通过 DescribeZones 接口查询指定地域中可用区的列表。

说明 使用沙箱功能前需要先开通 PrivateLink 服务,可通过 OpenPrivateLinkService 接口开通私网连接服务。
cn-hangzhou-b

返回参数

名称类型描述示例值
object
Datastring

报错信息。

operation forbidden due to sandbox is creating.
RequestIdstring

请求 ID。

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

错误码。

Param.NotFound
Successstring

是否请求成功。

true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Codestring

错误码。

Param.NotFound
Messagestring

错误信息。

The specified parameter %s value is not valid.

示例

正常返回示例

JSON格式

{
  "Data": "operation forbidden due to sandbox is creating.",
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Param.NotFound",
  "Message": "The specified parameter %s value is not valid."
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
2023-08-18OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ZoneId
错误码报错消息可能原因
Operation.DeniedByJobStatusoperation forbidden due to sandbox is creating无法释放正在创建中的沙箱实例。请在沙箱实例处于运行中时,再进行删除。
  • 本页导读 (1)