查询实例列表
更新时间:2022-12-28
说明
- 只能查看属于自己账号的实例列表
- 接口将每个主实例和其只读、代理实例分成一组,参数maxKeys代表分组数,也就是主实例的个数
请求结构
GET /v{version}/instance HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | string | 是 | URL参数 | API 版本号 |
marker | string | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量(主实例),最大数量通常不超过1000,缺省值为1000 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
marker | String | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | int | 每页包含的最大数量,最大数量通常不超过1000,缺省值为1000。 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
instances | List Instance | 由Instance对象组成的数组 |
请求示例
GET /v1/instance?marker=r-IyWRtII7&maxKeys=1 HTTP/1.1
HOST: rds.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
返回示例
{
"nextMarker": "rds-xktdeMSf",
"marker": "rds-IyWRtII7",
"maxKeys": 1,
"isTruncated": true,
"instances":[{
"instanceId" : "rds-IyWRtII7",
"instanceName" : "mysql5145",
"engine" : "mysql",
"engineVersion" : "5.6",
"characterSetName" : "utf8mb4",
"volumeCapacity" : 5,
"memoryCapacity" : 0.25,
"usedStorage" : 1.24,
"instanceStatus" : "Creating",
"instanceCreateTime" : "2016-06-01T12:00:00Z",
"instanceExpireTime" : "2016-07-01T12:00:00Z",
"instanceType" : "Master",
"zoneNames" :["cn-bj-a"],
"paymentTiming" : "Prepaid"
}]
}