获取实例列表
更新时间：2024-11-22
请求说明
- 只能查看属于自己账号的实例列表。
- 当前版本为v2。
请求结构
Plain Text
1GET /v2/instance?marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: redis.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| marker | String | 否 | URL参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | String | 否 | URL参数 | 每页包含的最大数量(主实例)，最大数量通常不超过1000，缺省值为1000 |
| instanceIds | String | 否 | URL参数 | 集群ID查询。支持多个实例ID，以英文逗号分隔。 |
| vnetIp | String | 否 | URL参数 | 内网IP查询。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 批量获取列表的查询的起始位置，是一个由系统生成的字符串,起始值可传入-1 |
| maxKeys | integer | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| instances | List<InstanceModel> | 由InstanceModel组成的数组 |
请求示例
Plain Text
1GET /v2/instance?marker=-1&maxKeys=20 HTTP/1.1
2HOST: redis.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/0255cb4f78f140728045b551d6a317ec/2018-11-13T05:57:04Z/1800/host/633fd6aadc177fce91e5e930c63886b5fb4da8938d9a02c9d13df4fdb8efdec5返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5 "marker": "-1",
6 "isTruncated": true,
7 "nextMarker": "1058",
8 "maxKeys": 1,
9 "instances": [
10 {
11 "instanceId": "scs-bj-cxisuftlkquj",
12 "instanceName": "post101",
13 "instanceStatus": "Running",
14 "engine": "redis",
15 "engineVersion": "3.2",
16 "vnetIp": "10.107.231.11",
17 "domain": "redis.ruqpwjmvrsyt.scs.bj.bce.qa.sandbox.baidu.com",
18 "port": "6379",
19 "instanceCreateTime": "2018-11-13T05:37:49Z",
20 "capacity": 1,
21 "usedCapacity": 0.06,
22 "paymentTiming": "Postpaid",
23 "zoneNames": [
24 "cn-bj-a",
25 "cn-bj-c"
26 ]
27 }
28 ]
29}