查询集群列表
更新时间:2022-09-28
查询集群列表
接口描述
本接口用于查询集群列表,只能查询属于自己账号的集群列表。
请求结构
GET /v{version}/gaiadb/cluster HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
version | string | 是 | Path参数 | API 版本号 |
marker | string | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串,第一次请求可以不设置,后续请求可以设置为上一次请求响应中的 marker 字段值 |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量通常不超过100,缺省值为100 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
marker | String | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | int | 每页包含的最大数量,最大数量通常不超过100,缺省值为100 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
clusters | List Cluster | 由Cluster对象组成的数组 |
请求示例
GET /v1/gaiadb/cluster?marker=r-IyWRtII7&maxKeys=1 HTTP/1.1
HOST: gaiadb.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
返回示例
{
"marker": "gaiadb08sk7o",
"maxKeys": 1,
"nextMarker": "gaiadb603pvc",
"isTruncated": true,
"clusters": [
{
"clusterId": "gaiadb08sk7o",
"clusterName": "zyh-param",
"endpoint": {
"port": 3306,
"address": "gaiadb08sk7o.gaiadb.bj.baidubce.com"
},
"allocatedCpuInCore": 2,
"allocatedMemoryInMB": 8192,
"instanceStatus": "available",
"publiclyAccessible": false,
"instanceCreateTime": "2022-09-19T07: 23: 47Z",
"instanceExpireTime": null,
"instanceAmount": 2,
"proxyAmount": 2,
"productType": "postpay",
"multiActiveGroupId": "",
"multiActiveGroupRole": "",
"multiActiveGroupName": ""
}
]
}