DeleteSandboxInstance - 释放沙箱实例 - 数据管理 DMS

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DeleteSandboxInstance

delete

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID。说明若您的实例为 RDS MySQL，请通过自动添加数据源功能，将 RDS 自动添加至 DBS 中，即可获取备份计划 ID。	1hxxxx8xxxxxa
InstanceId	string	是	沙箱实例 ID。	1jxxxxnxxx1xc
ZoneId	string	否	目标沙箱实例的可用区 ID，该可用区 ID 需要是 PrivateLink 服务支持的可用区 ID。可通过 DescribeZones 接口查询指定地域中可用区的列表。说明使用沙箱功能前需要先开通 PrivateLink 服务，可通过 OpenPrivateLinkService 接口开通私网连接服务。	cn-hangzhou-b

返回参数

名称	类型	描述	示例值
	object
Data	string	报错信息。	operation forbidden due to sandbox is creating.
RequestId	string	请求 ID。	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	错误码。	Param.NotFound
Success	string	是否请求成功。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
Code	string	错误码。	Param.NotFound
Message	string	错误信息。	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	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

更多信息，参考变更详情。