5.1 集群管理接口
5.1.3 查询集群详情
功能介绍
该接口用于查询集群详情。
API 参考 5 API 说明
调试
您可以在API Explorer调试该接口。
URI
● URI 格式
GET /v1.0/{project_id}/clusters/{cluster_id}
● 参数说明
表5-16 URI 参数说明
参数 是否
必选
参数类型 描述
project_id 是 String 项目ID。获取方法，请参见获取项目ID。
cluster_id 是 String 集群ID。获取方法，请参见获取集群ID。
请求消息
请求样例
GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7
响应消息
● 响应样例
{ "cluster": {
"id": "7d85f602-a948-4a30-afd4-e84f47471c15", "status": "AVAILABLE",
"name": "dws-1",
"updated": "2018-02-10T14:28:14Z", "created": "2018-02-10T14:28:14Z", "user_name": "dbadmin",
"sub_status": "READONLY", "task_status": "SNAPSHOTTING",
"action_progress": {"SNAPSHOTTING": "20%"}, "node_type": "dws.m1.xlarge.ultrahigh",
"subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720", "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b", "number_of_node": 3,
"availability_zone": "cn-north-4b", "port": 8000,
"vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574", "public_ip": {
"public_bind_type": "auto_assign",
"eip_id": "85b20d7e-9etypeb2a-98f3-3c8843ea3574"
},
"private_ip":["192.168.0.12","192.168.0.66"], "public_endpoints": [
{
"public_connect_info": "dws-1.cn-north-4.myhuaweicloud.com", "jdbc_url": "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/
<YOUR_DATABASE_name>"
} ],
"endpoints": [ {
"connect_info": "dws-1.cn-north-4.myhuaweicloud.com",
"jdbc_url": "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/
<YOUR_DATABASE_name>"
} ],
"version": "1.2.0", "maintain_window": { "day": "Wed", "start_time": "22:00", "end_time": "02:00"
},
"resize_info" : {
"target_node_num": "6", "origin_node_num": "3", "resize_status": "GROWING",
"start_time": "2018-02-14T14:28:14Z",
"origin_node_type": "dws.m1.xlarge.ultrahigh", "target_node_type":
"dws.d2.xlarge" },
"enterprise_project_id": "6a6a18fe-417a-4188-9214-75fd08c22065", "recent_event": 6,
"tags":[
{
"key": "key1", "value": "value1"
}, {
"key": "key2", "value": "value2"
} ],
"parameter_group": { "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc", "name": "Default-Parameter-Group-dws ", "status": "In-Sync"
} } }
● 参数说明
表5-17 响应参数说明
参数 参数类型 描述
cluster ClusterDetai
l object 集群详情对象
表5-18 ClusterDetail
参数 参数类型 描述
id String 集群ID
API 参考 5 API 说明
参数 参数类型 描述
status String 集群状态，有效值包
括：
● CREATING：创建中
● AVAILABLE：可用
● UNAVAILABLE：不可 用
● CREATION FAILED：
创建失败
● FROZEN：已冻结
name String 集群名称
updated String 集群上次修改时间，格
式为ISO8601：YYYY-MM-DDThh:mm:ssZ
created String 集群创建时间，格式为
ISO8601：YYYY-MM-DDThh:mm:ssZ
user_name String 管理员用户名
参数 参数类型 描述
sub_status String “可用”集群状态的子 状态，有效值包括：
● NORMAL：正常
● READONLY：只读
● REDISTRIBUTING：
重分布中
● REDISTRIBUTION-FAILURE：重分布失 败
● UNBALANCED：非 均衡
● UNBALANCED | READONLY：非均 衡，只读
● DEGRADED：节点故 障
● UNBALANCED | REDISTRIBUTING：
非均衡，重分布中
● UNBALANCED |
● UNBALANCED | READONLY | UNBALANCED |
REDISTRIBUTION-API 参考 5 API 说明
参数 参数类型 描述
FAILURE：节点故 障，非均衡，只读，
重分布失败
● DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE：节点故 障，非均衡，只读，
重分布失败
● DEGRADED | UNBALANCED | READONLY：节点故 障，非均衡，只读 task_status String 集群管理任务，有效值
包括：
● UNFREEZING：解冻 中
● FREEZING：冻结中
● RESTORING：恢复中
● SNAPSHOTTING：快 照中
● GROWING：扩容中
● REBOOTING：重启 中
● SETTING_CONFIGUR ATION：安全设置配 置中
● CONFIGURING_EXT_
DATASOURCE：MRS 连接配置中
● DELETING_EXT_DAT ASOURCE：删除MRS 连接
● REBOOT_FAILURE：
重启失败
● RESIZE_FAILURE：扩 容失败
参数 参数类型 描述
action_progress Map<String,String> key值为正在进行的任 务，有效值包括：
● GROWING：扩容中
● RESTORING：恢复中
● SNAPSHOTTING：快 照中
● REPAIRING : 修复中
● CREATING : 创建中 value值为正在进行任务 的进度。
node_type String 节点类型
subnet_id String 子网ID
security_group_id String 安全组ID number_of_node Integer 节点数量 availability_zone String 可用区
port Integer 集群服务端口
（8000~30000），默认 值：8000
vpc_id String 虚拟私有云ID
public_ip PublicIp object 公网IP地址，如果未指 定，则默认不使用公网 连接
private_ip Array of strings 内网IP地址列表 public_endpoints Array of
PublicEndpoints objects
集群的公网连接信息，
如果未指定，则默认不 使用公网连接信息。
endpoints Array of Endpoints
objects 集群的内网连接信息
version String 数据仓库版本
maintain_window MaintainWindow
object 集群维护时间窗信息
resize_info ResizeInfo object 集群扩容状态详情 enterprise_project_id String 企业项目ID。值为0表示
默认企业项目
“default”。
recent_event Integer 事件数
API 参考 5 API 说明
参数 参数类型 描述 tags Array of Tags objects 集群标签 parameter_group ParameterGroup
object 集群所关联的参数组信
息
node_type_id String 节点类型ID
failed_reasons FailedReason object 失败原因。如果为空，
则集群处于正常状态。
表5-19 FailedReason
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误信息。
表5-20 PublicIp
参数 是否
必选
参数类型 描述
public_bind_t
ype 是 String 弹性IP绑定类型，取值如下：
● auto_assign：自动绑定
● not_use：暂未使用
● bind_existing ：使用已有 eip_id 否 String 弹性IP的id
表5-21 PublicEndpoints
参数 是否
必选
参数类型 描述
public_connec
t_info 否 String 公网连接信息。
jdbc_url 否 String 公网JDBC URL，默认格式如下：
jdbc:postgresql://<
public_connect_info>/
<YOUR_DATABASE_name>
表5-22 Endpoints
参数 是否
必选
参数类型 描述
connect_info 是 String 内网连接信息。
jdbc_url 是 String 内网JDBC URL，默认格式如下：
jdbc:postgresql://< connect_info>/
<YOUR_DATABASE_name>
表5-23 MaintainWindow
参数 是否
必选
参数类型 描述
day 否 String 每周的维护时间，以天为粒度，取值如下
● Mon：星期一
● Tue：星期二
● Wed：星期三
● Thu：星期四
● Fri： 星期五
● Sat：星期六
● Sun：星期日
start_time 否 String 维护开始时间，显示格式为 HH：mm，
时区为GMT+0。
end_time 否 String 维护结束时间，显示格式为 HH：mm, 时 区为GMT+0。
表5-24 ResizeInfo
参数 参数类型 描述
target_node_
num Integer 扩容后的节点数量 origin_node_
num Integer 扩容前的节点数量 resize_status String 扩容状态，取值如下：
● GROWING：扩容中
● RESIZE_FAILURE：扩容失败
start_time String 扩容开始时间，格式为ISO8601：YYYY-MM-DDThh:mm:ss
API 参考 5 API 说明
表5-25 Tags
参数 参数类型 描述
key String 键。输入标签键的最大长度为36个unicode字 符，不能为空字符串，且首尾字符不能为空 格。 不能包含“=”,“*”,“<”,“>”,“\”,
“,”,“|”,“/”。 只能包含大写字母（A-Z）、小写字母（a-z）、数字（0-9）和特殊 字符（中划线-、下划线_）以及中文字符。
value String 值。输入标签值的最大长度为43个字符，首尾 字符不能为空格，可以为空字符串。 不能包含
“=”,“*”,“<”,“>”,“\”,“,”,“|”,
“/”。 只能包含大写字母（A-Z）、小写字母
（a-z）、数字（0-9）和特殊字符（中划线-、
下划线_）以及中文字符。
表5-26 ParameterGroup
参数 是否必
选
参数类 型
描述
id 是 String 参数组ID name 是 String 参数组名称
status 是 String 集群参数状态，有效值包括：
● In-Sync：已同步
● Applying：应用中
● Pending-Reboot：需重启生效
● Sync-Failure：应用失败
状态码
● 正常 200
● 异常
表5-27 返回值说明
返回值 描述
400 Bad Request 请求错误。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
返回值 描述 500 Internal Server
Error 服务内部错误
503 Service Unavailable 服务不可用。