查看当前账号下的沙箱实例列表。
接口说明
当前接口仅支持DBS API服务2021-01-01版本。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dbs:DescribeSandboxInstances | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BackupPlanId | string | 是 | 备份计划ID，您可以通过DescribeBackupPlanList接口获取该参数。 说明若您的实例为RDS MySQL，请通过自动添加数据源功能，将RDS自动添加至DBS中，即可获取备份计划ID。 | 1hxxxx8xxxxxa |
| InstanceId | string | 否 | 沙箱实例ID，您可以通过CreateSandboxInstance接口获取该参数。 | 1jxxxxnxxx1xc |
| PageSize | string | 否 | 每页的记录数。取值：
| 30 |
| PageNumber | string | 否 | 页码，大于0且不超过Integer的最大值，默认值为1。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"Data": " { \"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 }",
"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."
}错误码
访问错误中心查看更多错误码。
| 错误码 | 报错消息 | 可能原因 |
|---|---|---|
| DBS.NotExisted | no valid job exist with id | InstanceId参数所对应的备份计划不存在。 |