文档

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.

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
错误码报错消息可能原因
DBS.NotExistedno valid job exist with idInstanceId 参数所对应的备份计划不存在。
  • 本页导读 (1)
文档反馈