实例组列表
更新时间：2023-04-24
接口描述
本接口用于查询实例组列表。
本接口为v1接口。
请求结构
GET /v{version}/instance/group?manner=page&order=desc&orderBy=name&pageNo=1&pageSize=2 HTTP/1.1
Host: rds.bj.baidubce.com
Content-Type: application/json
Authorization: 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参数 | 每页的数量 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List GroupInfo | 返回参数 |
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页的数量 |
| totalCount | Integer | 总数量 |
GroupInfo详情
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 实例组Id |
| name | String | 实例名称 |
| count | Integer | 主实例数量 |
| leader | Instance | 主角色 |
Instance详情
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIdShort | String | 实例Id |
| region | String | 地域 |
| azone | String | 可用区 |
| status | String | 实例状态 |
| lockMode | String | 锁定模式 |
| name | String | 实例名称 |
请求示例
GET http://rds.bj.baidubce.com/v1/instance/group?manner=page HTTP/1.1
HOST: rds.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
"result": [
{
"groupId": "rdcfvvjpbos",
"name": "testgroup",
"count": 1,
"leader": {
"instanceId": "rdsm27tq4s441di",
"instanceIdShort": "rds-Tc7AGFvj",
"region": "bj",
"azone": "zoneD",
"status": "azoneChanging",
"lockMode": "unlock",
"name": "mysql57"
},
},
"pageNo": 1,
"pageSize": 2,
"totalCount": 2
}