5.1 集群管理
5.1.1 查询集群详情
功能介绍
查询集群详情接口。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1.1/{project_id}/clusters/{cluster_id}
表5-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID cluster_id 是 String 集群ID
请求参数
表5-2 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
响应参数
状态码： 200
表5-3 响应 Body 参数
参数 参数类型 描述
publicEndpoin
t String 集群绑定的EIP
instances Array of ClusterDetail Instance objects
集群的节点信息，请参见instances参数说明
security_grou
p_id String 安全组id subnet_id String 子网id
vpc_id String 虚拟私有云ID customerConf
ig CustomerConf
ig object 用户配置信息
datastore Datastore
object cdm信息 isAutoOff Boolean 自动关机 publicEndpoin
tDomainNam e
String 集群绑定的EIP域名
bakExpectedS
tartTime String 开始时间 bakKeepDay Integer 保留时间 maintainWind
ow maintainWin
dow object 维护窗口
参数 参数类型 描述 recentEvent Integer 事件数 flavorName String 规格名称 azName String az名称 endpointDom
ainName String 对端域名 publicEndpoin
tStatus publicEndpoi ntStatus object
EIP状态信息
isScheduleBoo
tOff Boolean 选择是否启用定时开关机功能。定时开关机功能 和自动关机功能不可同时开启
namespace String 命名空间 eipId String 弹性ip id failedReasons FailedReason
s object 失败原因。集群处于正常状态时不返回。
dbuser String 数据库用户 links Array of
ClusterLinks objects
集群连接信息
clusterMode String 集群模式：sharding(分片集群)
task ClusterTask
object 任务信息
created String 集群创建时间，格式为ISO8601：YYYY-MM-DDThh:mm:ssZ
statusDetail String 集群状态描述：Normal（正常）
config_status String 集群配置状态：
● In-Sync：配置已同步。
● Applying：配置中。
● Sync-Failure：配置失败 actionProgres
s ActionProgre
ss object 集群操作进度，任务信息，由key、value组成。
key值为正在进行的任务，value值为正在进行任 务的进度。示例如 "action_progress":
{"SNAPSHOTTING":"16%"}
name String 集群名称
id String 集群ID
isFrozen String 集群是否冻结：0：否1：是
参数 参数类型 描述 actions Array of
strings 集群配置状态：In-Sync：配置已同步。
Applying：配置中。Sync-Failure：配置失败 updated String 集群更新时间，格式为
ISO8601：YYYY-MM-DDThh:mm:ssZ status String 集群状态：
● 100：创建中
● 200：正常
● 300：失败
● 303：创建失败
● 800：冻结
● 900：已关机
● 910：正在关机
● 920：正在开机
表5-4 ClusterDetailInstance
参数 参数类型 描述
flavor flavor object 节点的虚拟机规格，请参见flavor参数说明（查询 集群列表时返回值为null）。
volume volume
object 节点的磁盘信息，请参见volume参数说明（查询 集群列表时返回值为null）。
status String 节点状态：
● 100：创建中。
● 200：正常。
● 300：失败。
● 303：创建失败。
● 400：已删除。
● 800：冻结。
actions Array of
strings 节点操作状态列表：
● REBOOTING：重启中。
● RESTORING：恢复中。
● REBOOT_FAILURE：重启失败。
type String 节点类型，只支持一种类型“cdm”。
id String 节点的虚拟机ID。
name String 节点的虚拟机名称。
参数 参数类型 描述
isFrozen String 节点是否冻结：0：否。1：是。
components String 组件
config_status String 节点配置状态（查询集群列表时为null）：
● In-Sync：配置已同步。
● Applying：配置中。
● Sync-Failure：配置失败。
role String 实例角色
group String 分组 links Array of
ClusterLinks objects
链接信息（查询集群列表时返回值为null）
paramsGroupI
d String 组件分组id
publicIp String 公网ip manageIp String 管理ip trafficIp String 流量ip shard_id String 分片id manage_fix_i
p String 管理修复ip
private_ip String 私有ip internal_ip String 内部ip resource Array of
Resource objects
资源信息（查询集群列表时返回值为null）
表5-5 flavor
参数 参数类型 描述
id String 节点虚拟机的规格ID。
links Array of ClusterLinks objects
链接信息
表5-6 volume
参数 参数类型 描述
type String 节点的磁盘类型，只支持本地磁盘
size Long 节点磁盘大小，单位G。
表5-7 Resource
参数 参数类型 描述
resource_id String 资源id
resource_type String 资源类型：server(服务器)
表5-8 CustomerConfig
参数 参数类型 描述
failureRemind String 失败提醒。
clusterName String 集群类型。
serviceProvide
r String 服务提供
localDisk String 是否本地磁盘。
ssl String 是否使用ssl。
createFrom String 创建来源 resourceId String 资源ID flavorType String 规格类型 workSpaceId String 工作空间ID trial String 适用
表5-9 Datastore
参数 参数类型 描述
type String 类型，一般为cdm。
version String 集群版本。
表5-10 maintainWindow
参数 参数类型 描述
day String 周几
startTime String 开始时间。
endTime String 结束时间。
表5-11 publicEndpointStatus
参数 参数类型 描述
status String 状态 errorMessage String 错误信息
表5-12 FailedReasons
参数 参数类型 描述
CREATE_FAILE
D CREATE_FAIL
ED object 集群创建失败原因。
表5-13 CREATE_FAILED
参数 参数类型 描述
errorCode String 错误码 errorMsg String 失败原因
表5-14 ClusterLinks
参数 参数类型 描述
rel String 关系
href String 链接地址
表5-15 ClusterTask
参数 参数类型 描述
description String 任务描述
参数 参数类型 描述
id String 任务id
name String 任务名称
表5-16 ActionProgress
参数 参数类型 描述
CREATING String 创建集群进度，例如：29%
GROWING String 扩容集群进度，例如：29%
RESTORING String 恢复集群进度，例如：29%
SNAPSHOTTI
NG String 集群快照进度，例如：29%
REPAIRING String 修复集群进度，例如：29%
请求示例
GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/bae65496-643e-47ca-84af-948672de7eeb
响应示例
状态码： 200 ok
{ "clusters" : {
"publicEndpoint" : "49.xx.xx.10", "instances" : [ {
"flavor" : {
"id" : "fb8fe666-6734-4b11-bc6c-43d11db3c745"
},
"volume" : { "size" : "100", "type" : "LOCAL_DISK"
},
"name" : "cdm-c018",
"id" : "635dce67-3df8-4756-b4c7-90e45e687367", "isFrozen" : "0",
"type" : "cdm",
"actions" : "REBOOTING", "config_status" : "In-Sync", "status" : "200"
} ],
"created" : "2018-09-05T08:38:25", "statusDetail" : "Normal", "config_status" : "In-Sync", "version" : "1.8.10", "actionProgress" : { }, "name" : "cdm-c018",
"id" : "bae65496-643e-47ca-84af-948672de7eeb", "isFrozen" : "0",
"actions" : "REBOOTING",
"updated" : "2018-09-05T08:38:25", "status" : "200"
}}
状态码
状态码 描述
200 ok
400 请求错误
401 鉴权失败
403 没有操作权限
404 找不到资源
500 服务内部错误，具体返回错误码请参考错误码
503 服务不可用
错误码
请参见错误码。