首页 >数据库备份 DBS >API参考(2021-01-01) >API目录 >沙箱实例 >DescribeSandboxInstances - 查看沙箱实例列表

DescribeSandboxInstances - 查看沙箱实例列表

调用DescribeSandboxInstances接口,查看当前账号下的沙箱实例列表。

接口说明

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

调试

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

调试

授权信息

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

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

    请求参数

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

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

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

    沙箱实例ID,您可以通过CreateSandboxInstance接口获取该参数。

    1jxxxxnxxx1xc
    PageSizestring

    每页的记录数。取值:

    • 30(默认)
    • 50
    • 100
    30
    PageNumberstring

    页码,大于0且不超过Integer的最大值,默认值为1。

    1

    返回参数

    名称类型描述示例值
    object
    Datastring

    参数说明:

    • connectionString:沙箱实例的连接字符串,格式为IP:Port。当SandboxType为Sandbox时,该参数表示沙箱实例的连接地址;当SandboxType为NFS时,该参数表示NFS挂载地址。
    • restoreSeconds:创建沙箱实例所需的时长,单位为秒。
    • restoreTime:恢复的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
    • instanceId:沙箱实例ID。
    • backupSetId:备份集ID。
    • createTime:沙箱实例的创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
    • backupPlanId:备份计划ID。
    • vpcId:专有网络VPC(Virtual Private Cloud) ID。
    • vpcSwitchId:VPC交换机ID。
    • sandboxSpecification:沙箱实例规格。
    • status:沙箱实例状态,运行中(running)、预检查通过(check_pass)、异常(stop)。
    { "number": 1, "size": 1, "content": [ { "connectionString": "172.26.178.229:3306", "restoreSeconds": 15, "restoreTime": "2021-08-11T07:26:24Z", "instanceId": "1jxxxxx9xxxms", "backupSetId": "1hxxxx8xxxxxa_20210811152624", "createTime": "2021-08-12T07:40:29Z", "backupPlanId": "1hxxxx8xxxxxa", "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp", "sandboxSpecification": "MYSQL_1C_1M_SD", "status": "running", "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxx2w" } ], "totalElements": 1 }
    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.

    示例

    请求示例

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

    正常返回示例

    JSON格式

    {
        "RequestId": "96A7FD36-9C81-5AA1-A605-C98ED00B0931",
        "Data": {
            "number": 2,
            "size": 2,
            "content": [
                {
                    "connectionString": "172.27.135.92:3306",
                    "restoreSeconds": 64,
                    "restoreTime": "2021-08-16T13:25:21Z",
                    "instanceId": "1jxxxxx9xxxxh",
                    "backupSetId": "BINLOG_1hxxxx8xxxxxa_20210811152624_mysql-bin.000031",
                    "createTime": "2021-08-16T13:43:09Z",
                    "backupPlanId": "1hxxxx8xxxxxa",
                    "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp",
                    "sandboxSpecification": "MYSQL_1C_1M_SD",
                    "status": "running",
                    "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxxx9"
                },
                {
                    "connectionString": "172.26.178.229:3306",
                    "restoreSeconds": 15,
                    "restoreTime": "2021-08-11T07:26:24Z",
                    "instanceId": "1jxxxxx9xxxms",
                    "backupSetId": "1hxxxx8xxxxxa_20210811152624",
                    "createTime": "2021-08-12T07:40:29Z",
                    "backupPlanId": "1hxxxx8xxxxxa",
                    "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp",
                    "sandboxSpecification": "MYSQL_1C_1M_SD",
                    "status": "running",
                    "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxx2w"
                }
            ],
            "totalElements": 2
        },
        "Code": "Success",
        "Success": true,
        "ErrCode": "Success"
    }

    XML格式

    <RequestId>96A7FD36-9C81-5AA1-A605-C98ED00B0931</RequestId>
    <Data>
        <number>2</number>
        <size>2</size>
        <content>
            <connectionString>172.27.135.92:3306</connectionString>
            <restoreSeconds>64</restoreSeconds>
            <restoreTime>2021-08-16T13:25:21Z</restoreTime>
            <instanceId>1jxxxxx9xxxxh</instanceId>
            <backupSetId>BINLOG_1hxxxx8xxxxxa_20210811152624_mysql-bin.000031</backupSetId>
            <createTime>2021-08-16T13:43:09Z</createTime>
            <backupPlanId>1hxxxx8xxxxxa</backupPlanId>
            <vpcId>vpc-bp1dxxxxxjy0xxxxx1xxp</vpcId>
            <sandboxSpecification>MYSQL_1C_1M_SD</sandboxSpecification>
            <status>running</status>
            <vpcSwitchId>vsw-bp1bxxxxxumxxxxxwxxx9</vpcSwitchId>
        </content>
        <content>
            <connectionString>172.26.178.229:3306</connectionString>
            <restoreSeconds>15</restoreSeconds>
            <restoreTime>2021-08-11T07:26:24Z</restoreTime>
            <instanceId>1jxxxxx9xxxms</instanceId>
            <backupSetId>1hxxxx8xxxxxa_20210811152624</backupSetId>
            <createTime>2021-08-12T07:40:29Z</createTime>
            <backupPlanId>1hxxxx8xxxxxa</backupPlanId>
            <vpcId>vpc-bp1dxxxxxjy0xxxxx1xxp</vpcId>
            <sandboxSpecification>MYSQL_1C_1M_SD</sandboxSpecification>
            <status>running</status>
            <vpcSwitchId>vsw-bp1bxxxxxumxxxxxwxx2w</vpcSwitchId>
        </content>
        <totalElements>2</totalElements>
    </Data>
    <Code>Success</Code>
    <Success>true</Success>
    <ErrCode>Success</ErrCode>

    错误码

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

    错误码报错消息可能原因
    DBS.NotExistedno valid job exist with idInstanceId参数所对应的备份计划不存在。
    阿里云首页 数据库备份 DBS 相关技术圈