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

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

调试

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

请求参数

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

系统规定参数。取值:DescribeSandboxInstances

BackupPlanId String 1hxxxx8xxxxxa

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

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

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

PageSize String 30

每页的记录数。取值:

  • 30(默认)
  • 50
  • 100
PageNumber String 1

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

返回数据

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

错误码。

Data String { "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 }

参数说明:

  • 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)。
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=DescribeSandboxInstances
&<公共请求参数>

正常返回示例

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>

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"
}

错误码

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

错误码

报错消息

可能原因

DBS.NotExisted

no valid job exist with id

InstanceId参数所对应的备份计划不存在。