接口功能介绍
分页查询分组列表。
接口约束
请先订购实例。
URI
GET /v2/group/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 | |
name | 否 | String | 分组名称,模糊搜索,大小写不敏感 | 默认分组 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 分组id | ||
name | 是 | String | 分组名称 | 默认分组 | |
memo | 是 | String | 分组描述 | 默认分组 | |
vip | 是 | String | 连接ip | 172.16.0.3 | |
isDefault | 是 | Boolean | 是否默认分组 | true | |
nodes | 是 | Array of Objects | 节点列表 | node |
表 node
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 节点名称 | n1 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": [
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000121/groups/group_0000000176",
"vip": "172.16.0.3",
"name": "默认分组",
"memo": "默认分组",
"isDefault": true,
"nodes": [
{
"name": "n1"
},
{
"name": "n2"
}
]
}
]
}
状态码
请参考 状态码说明。