全部产品
Search

搜索本产品

    数据库备份 DBS：DeleteSandboxInstance - 释放沙箱实例

    文档中心

    数据库备份 DBS：DeleteSandboxInstance - 释放沙箱实例

    更新时间：Mar 27, 2023

    释放沙箱实例。

    接口说明

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

    调试

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

    调试

    授权信息

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

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

    请求参数

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

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

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

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

    		1jxxxxnxxx1xc

    返回参数

    名称类型描述示例值
    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."
}

    错误码

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

    错误码报错消息可能原因
    Operation.DeniedByJobStatusoperation forbidden due to sandbox is creating无法释放正在创建中的沙箱实例。请在沙箱实例处于运行中时，再进行删除。