实例组列表
更新时间：2023-12-25
接口描述
本接口用于查询实例组列表。
本接口为v1接口。
请求结构
Plain Text
1GET /v{version}/instance/group?manner=page&order=desc&orderBy=name&pageNo=1&pageSize=2 HTTP/1.1
2Host: rds.bj.baidubce.com
3Content-Type: application/json
4Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | Integer | 是 | Path参数 | API 版本号，此处值为1 |
| manner | String | 是 | Query参数 | 默认为page |
| order | String | 否 | Query参数 | 排序规则：asc(升序)/desc（降序） |
| orderBy | String | 否 | Query参数 | 排序字段，例如name |
| pageNo | Integer | 否 | Query参数 | 当前页 |
| pageSize | Integer | 否 | Query参数 | 每页的数量 |
| filterMapStr | String | 否 | Query参数 | 筛选符合当前字符串json，从groupId、groupName、instanceStatus 三个字段筛选数据 filter_map_str = "{"groupId":"rdcqzga9i4s"}" filter_map_str = "{"groupName":"acount-test"}" filter_map_str = "{"instanceStatus":"topoModifying"}" |
| daysToExpiration | String | 否 | Query参数 | 截止日期， 默认为-1 |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List GroupInfo | 返回参数 |
GroupInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orders | OrderModel | 订单字段 |
| orderBy | String | 排序字段 |
| order | String | 排序类型 asc |
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页的数量 |
| totalCount | Integer | 总数量 |
GroupInfo详情
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 实例组Id |
| name | String | 实例名称 |
| count | Integer | 主实例数量 |
| leader | GroupMember | 主角色 |
| followers | List<GroupMember> | 从角色 |
GroupMember详情
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 实例Id |
| instanceIdShort | String | 短实例Id |
| region | String | 地域 |
| azone | String | 可用区 |
| status | String | 实例状态 |
| lockMode | String | 锁定模式 |
| name | String | 实例名称 |
请求示例
Plain Text
1GET http://rds.bj.baidubce.com/v1/instance/group?manner=page&pageNo=1&pageSize=2 HTTP/1.1
2HOST: rds.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3{
4 "result": [
5 {
6 "groupId": "rdcj7hyv4nk",
7 "name": "lcy_test",
8 "count": 1,
9 "leader": {
10 "instanceId": "rdsmzvcnoiv4j1u",
11 "instanceIdShort": "rds-yitl2eBB",
12 "region": "bj",
13 "azone": "zoneD",
14 "status": "available",
15 "lockMode": "unlock",
16 "name": "mysql57_openAPI测试"
17 }
18 },
19 {
20 "groupId": "rdcsn5fp4ij",
21 "name": "lisagroup1",
22 "count": 2,
23 "leader": {
24 "instanceId": "rdsmt6hecolmmvj",
25 "instanceIdShort": "rds-kJzX8uLs",
26 "region": "nj",
27 "azone": "zoneB",
28 "status": "available",
29 "lockMode": "unlock",
30 "name": "勿动-lisa-mysql57"
31 }
32 }
33 ],
34 "orders": null,
35 "orderBy": null,
36 "order": null,
37 "pageNo": 1,
38 "pageSize": 2,
39 "totalCount": 2
40}