实例组列表

更新时间：2023-12-25

接口描述

本接口用于查询实例组列表。

本接口为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参数	每页的数量
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	实例名称

请求示例

GET http://rds.bj.baidubce.com/v1/instance/group?manner=page&pageNo=1&pageSize=2 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": "rdcj7hyv4nk",
            "name": "lcy_test",
            "count": 1,
            "leader": {
                "instanceId": "rdsmzvcnoiv4j1u",
                "instanceIdShort": "rds-yitl2eBB",
                "region": "bj",
                "azone": "zoneD",
                "status": "available",
                "lockMode": "unlock",
                "name": "mysql57_openAPI测试"
            }
        },
        {
            "groupId": "rdcsn5fp4ij",
            "name": "lisagroup1",
            "count": 2,
            "leader": {
                "instanceId": "rdsmt6hecolmmvj",
                "instanceIdShort": "rds-kJzX8uLs",
                "region": "nj",
                "azone": "zoneB",
                "status": "available",
                "lockMode": "unlock",
                "name": "勿动-lisa-mysql57"
            }
        }
    ],
    "orders": null,
    "orderBy": null,
    "order": null,
    "pageNo": 1,
    "pageSize": 2,
    "totalCount": 2
}

创建实例组

实例组详情

云数据库 RDS

云数据库 RDS

实例组列表