调用DeleteSandboxInstance接口,释放沙箱实例。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DeleteSandboxInstance

系统规定参数。取值:DeleteSandboxInstance

BackupPlanId String 1hxxxx8xxxxxa

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

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

沙箱实例ID,您可以通过CreateSandboxInstance接口或DescribeSandboxInstances接口获取。

返回数据

名称 类型 示例值 描述
Code String Param.NotFound

错误码。

Data String operation forbidden due to sandbox is creating.

报错信息。

ErrCode String Param.NotFound

错误码。

ErrMessage String The specified parameter %s value is not valid.

错误信息。

Message String The specified parameter %s value is not valid.

错误信息。

RequestId String 4F1888AC-1138-4995-B9FE-D2734F61C058

请求ID。

Success String true

是否请求成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DeleteSandboxInstance
&<公共请求参数>

正常返回示例

XML格式

<RequestId>41F0B1A5-A615-5C2E-AC01-D511F040D421</RequestId>
<Code>Success</Code>
<Success>true</Success>
<ErrCode>Success</ErrCode>

JSON格式

{
    "RequestId": "41F0B1A5-A615-5C2E-AC01-D511F040D421",
    "Code": "Success",
    "Success": true,
    "ErrCode": "Success"
}

错误码

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

错误码

报错消息

可能原因

Operation.DeniedByJobStatus

operation forbidden due to sandbox is creating

无法释放正在创建中的沙箱实例。请在沙箱实例处于运行中时,再进行删除。