查询集群详情
更新时间：2023-09-22
查询集群详情
接口描述
本接口用于查询指定集群的详细信息。
请求结构
GET /v{version}/gaiadb/cluster/{clusterId} HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API 版本号 |
| clusterId | String | 是 | URL参数 | 指定集群Id |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| clusterId | String | 集群ID |
| clusterName | String | 集群名 |
| allocatedCpuInCore | Int | CPU核数 |
| allocatedMemoryInMB | Int | 集群内存，单位GB |
| instanceStatus | String | 实例状态，参见集群状态表 |
| publicAccessStatus | String | 外网访问功能状态,参考公网状态表 |
| instanceCreateTime | Datetime | 实例创建时间，规范参考时间与日期 |
| instanceExpireTime | Datetime | 实例到期时间，规范参考时间与日期 |
| instanceAmount | Int | 节点数 |
| productType | String | 付费方式，取值：prepay（预付费）、postpay（后付费） |
| multiActiveGroupId | String | 集群所属热活集群组ID，若集群未在任何热活集群组中，则为空字符串 |
| multiActiveGroupRole | String | 集群在热活集群组中的角色，若集群未在任何热活集群组中，则为空字符串 |
| multiActiveGroupName | String | 群所属热活集群组名称，若集群未在任何热活集群组中，则为空字符串 |
| endpoint | Endpoint | 数据库连接信息 |
| region | String | 该实例的区域 |
| computeList | List<ComputeNode> | 节点列表 |
ComputeNode 对象
| 参数名称 | 类型 | 描述 |
|---|---|---|
| role | String | primary：主节点、secondary：从节点 |
| instanceId | String | 实例Id |
| instanceShortId | Endpoint | 实例短Id |
| instanceUniqueId | String | 实例唯一Id |
| instanceStatus | String | 实例状态，参见集群状态表 |
请求示例
GET /v1/gaiadb/cluster/gaiadbxxxxxx HTTP/1.1
HOST: gaiadb.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
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
"clusterId": "gaiadbxxxxxx",
"clusterName": "zxxxxx",
"endpoint": {
"port": 3306,
"address": "172.16.1.128",
"vnetIp": "gaiadb08sk7o-dbproxy.gaia.all",
"inetIp": ""
},
"allocatedCpuInCore": 2,
"allocatedMemoryInMB": 8192,
"instanceStatus": "available",
"publiclyAccessible": false,
"instanceCreateTime": "2022-09-19T07: 23: 47Z",
"instanceExpireTime": null,
"instanceAmount": 2,
"productType": "postpay",
"multiActiveGroupId": "",
"multiActiveGroupRole": "",
"multiActiveGroupName": "",
"computeList": [
{
"role": "primary",
"instanceId": "node_10.147.65.164_3229",
"instanceShortId": "gaia-51059",
"instanceUniqueId": "gaiadb08sk7o-primary-2788664c",
"status": "available"
},
{
"role": "secondary",
"instanceId": "node_10.68.236.18_3229",
"instanceShortId": "gaia-51060",
"instanceUniqueId": "gaiadb08sk7o-secondary-fc1bf2a7",
"status": "available"
}
]
}