调用CreateSandboxInstance接口,创建沙箱实例。

执行该操作前,您需要先开启数据库实例的沙箱功能,详情请参见RDS MySQL应急恢复自建MySQL应急恢复(沙箱实例)

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

调试

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

请求参数

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

系统规定参数。取值:CreateSandboxInstance

BackupPlanId String 1hxxxx8xxxxxa

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

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

自定义沙箱实例名。

VpcId String vpc-bp1dxxxxxjy0xxxxx1xxp

专有网络VPC(Virtual Private Cloud) ID,用于访问沙箱实例。

如需通过ECS访问沙箱实例,需确保此处选择ECS实例所在的VPC。

说明 若您在恢复演练场景下使用,可以输入该参数。
VpcSwitchId String vsw-bp1bxxxxxumxxxxxwxxx9

VPC交换机ID,用于访问沙箱实例。

BackupSetId String 1hxxxx8xxxxxa_20210829064228

待恢复的备份集ID,即快照点,您可以通过DescribeSandboxBackupSets接口获取该参数。

说明 该参数(BackupSetId)与RestoreTime参数传入一个即可。
RestoreTime String 2021-08-01T12:01:01Z

待恢复时间点。您可以通过调用DescribeSandboxRecoveryTime接口,查看可恢复时间范围,格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

SandboxSpecification String MYSQL_1C_1M_SD

沙箱实例规格。取值范围:

  • MYSQL_1C_1M_SD:1核1 GB
  • MYSQL_1C_2M_SD:1核2 GB
  • MYSQL_2C_4M_SD:2核4 GB
  • MYSQL_2C_8M_SD:2核8 GB
  • MYSQL_4C_8M_SD:4核8 GB
  • MYSQL_4C_16M_SD:4核16 GB
  • MYSQL_8C_16M_SD:8核16 GB
  • MYSQL_8C_32M_SD:8核32 GB
说明 不同规格对恢复速度影响不大,高规格实例将在恢复后提供更好的使用性能,详情请参见沙箱实例费用
SandboxUser String root_test

新建的高权限账号。

  • 输入该参数后,系统会在创建的新沙箱实例中,新建一个高权限账号,即拥有实例里所有数据库的权限。

    同时沙箱实例中仍保留原数据库的账号。

  • 不输入该参数,数据库账号与原数据库保存一致。
SandboxPassword String password123

新建高权限账号的密码。

SandboxType String Sandbox

沙箱实例类型。仅支持通过该接口创建Sandbox类型,在创建沙箱实例后,提供MySQL的连接地址。

返回数据

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

错误码。

Data Struct

描述。

BackupPlanId String 1hxxxx8xxxxxa

备份计划ID。

InstanceId String 1jxxxxx9xxxxh

沙箱实例ID。

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=CreateSandboxInstance
&<公共请求参数>

正常返回示例

XML格式

<CreateSandboxInstanceResponse>
  <RequestId>25CA50CB-88C9-5D7D-A251-87618C659994</RequestId>
  <Data>
        <InstanceId>1jxxxxx9xxxxh</InstanceId>
        <BackupPlanId>1hxxxx8xxxxxa</BackupPlanId>
  </Data>
  <Code>Success</Code>
  <Success>true</Success>
  <ErrCode>Success</ErrCode>
</CreateSandboxInstanceResponse>

JSON格式

{
    "RequestId": "25CA50CB-88C9-5D7D-A251-87618C659994",
    "Data": {
        "InstanceId": "1jxxxxx9xxxxh",
        "BackupPlanId": "1hxxxx8xxxxxa"
    },
    "Code": "Success",
    "Success": true,
    "ErrCode": "Success"
}

错误码

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

错误码

错误信息

描述

DBS.ScenesNotSupport

Current backup plan does not support sandbox

该备份计划不支持沙箱功能。

DBS.ScenesNotSupport

Current backup plan does not enable sandbox

该备份计划未开启沙箱功能。

DBS.NotExisted

no valid job exist with id

该备份计划不存在。

DBS.NotExisted

No recoverable snapshot

无可用快照。

DBS.ParamInvalid

The input parameter vpcSwitchId that is mandatory for processing this request is not supplied

输入了VPC ID但是没有输入VPCSwitch ID。

DBS.ParamInvalid

The input parameter vpcId that is mandatory for processing this request is not supplied

输入了VPCSwitch ID但是没有输入VPC ID。

DBS.ParamInvalid

The specified parameter BackupSetId is invalid:

无效的快照ID或指定的快照不存在。

DBS.ParamInvalid

The input parameter BackupSetId/RestoreTime that is mandatory for processing this request is not supplied

BackupSetId参数或RestoreTime至少需要传入一个。

DBS.ParamInvalid

The specified parameter SandboxSpecification is invalid

输入的SandboxSpecification参数(沙箱实例规格)无效。

DBS.ParamInvalid

The specified parameter SandboxPassword is invalid

输入了SandboxUser参数,但是输入的SandboxPassword参数无效,例如未传入或者密码不符合规范。

DBS.ParamInvalid

The specified parameter SandboxType is invalid

输入的沙箱实例类型无效。

DBS.InternalError

内部错误。