首页 >数据库备份 DBS >API参考(2021-01-01) >API目录 >沙箱实例 >CreateSandboxInstance - 创建沙箱实例

CreateSandboxInstance - 创建沙箱实例

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

接口说明

执行该操作前,您需要先开启数据库实例的沙箱功能,详情请参见RDS MySQL应急恢复自建MySQL应急恢复(沙箱实例)。 当前接口仅支持DBS API服务2021-01-01版本。

调试

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

调试

授权信息

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

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

    请求参数

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

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

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

    自定义沙箱实例名。

    test_sandbox
    VpcIdstring

    专有网络VPC(Virtual Private Cloud) ID,用于访问沙箱实例。 如需通过ECS访问沙箱实例,需确保此处选择ECS实例所在的VPC。

    说明若您在恢复演练场景下使用,可以输入该参数。
    vpc-bp1dxxxxxjy0xxxxx1xxp
    VpcSwitchIdstring

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

    vsw-bp1bxxxxxumxxxxxwxxx9
    BackupSetIdstring

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

    说明该参数(BackupSetId)与RestoreTime参数传入一个即可。
    1hxxxx8xxxxxa_20210829064228
    RestoreTimestring

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

    2021-08-01T12:01:01Z
    SandboxSpecificationstring

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

    • 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
    说明不同规格对恢复速度影响不大,高规格实例将在恢复后提供更好的使用性能,详情请参见沙箱实例费用
    MYSQL_1C_1M_SD
    SandboxUserstring

    新建的高权限账号。

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

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

    • 不输入该参数,数据库账号与原数据库保存一致。
    root_test
    SandboxPasswordstring

    新建高权限账号的密码。

    password123
    SandboxTypestring

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

    Sandbox

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求ID。

    4F1888AC-1138-4995-B9FE-D2734F61****
    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.
    Dataobject

    描述。

    BackupPlanIdstring

    备份计划ID。

    1hxxxx8xxxxxa
    InstanceIdstring

    沙箱实例ID。

    1jxxxxx9xxxxh

    示例

    请求示例

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

    正常返回示例

    JSON格式

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

    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>

    错误码

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

    错误码错误信息描述
    DBS.ScenesNotSupportCurrent backup plan does not support sandbox该备份计划不支持沙箱功能。
    DBS.ScenesNotSupportCurrent backup plan does not enable sandbox该备份计划未开启沙箱功能。
    DBS.NotExistedno valid job exist with id该备份计划不存在。
    DBS.NotExistedNo recoverable snapshot无可用快照。
    DBS.ParamInvalidThe input parameter vpcSwitchId that is mandatory for processing this request is not supplied输入了VPC ID但是没有输入VPCSwitch ID。
    DBS.ParamInvalidThe input parameter vpcId that is mandatory for processing this request is not supplied输入了VPCSwitch ID但是没有输入VPC ID。
    DBS.ParamInvalidThe specified parameter BackupSetId is invalid无效的快照ID或指定的快照不存在。
    DBS.ParamInvalidThe input parameter BackupSetId/RestoreTime that is mandatory for processing this request is not suppliedBackupSetId参数或RestoreTime至少需要传入一个。
    DBS.ParamInvalidThe specified parameter SandboxSpecification is invalid输入的SandboxSpecification参数(沙箱实例规格)无效。
    DBS.ParamInvalidThe specified parameter SandboxPassword is invalid输入了SandboxUser参数,但是输入的SandboxPassword参数无效,例如未传入或者密码不符合规范。
    DBS.ParamInvalidThe specified parameter SandboxType is invalid输入的沙箱实例类型无效。
    DBS.InternalError内部错误。
    阿里云首页 数据库备份 DBS 相关技术圈