查询逻辑集群列表
功能介绍
查询逻辑集群列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
cluster_id |
是 |
String |
参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 10 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
logical_clusters |
Array of LogicalClusterInfo objects |
参数解释: 逻辑集群列表信息。 取值范围: 不涉及。 |
count |
Integer |
参数解释: 逻辑集群总数量。 取值范围: 不涉及。 |
add_enable |
Boolean |
参数解释: 作为互斥结果,如果集群内有其他运维操作,该值为false,此时不能添加逻辑集群。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
logical_cluster_id |
String |
参数解释: 逻辑集群ID。 取值范围: 不涉及。 |
logical_cluster_name |
String |
参数解释: 逻辑集群名称。 取值范围: 不涉及。 |
cluster_rings |
Array of ClusterRing objects |
参数解释: 逻辑集群主机信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 逻辑集群状态。 取值范围: 不涉及。 |
first_logical_cluster |
Boolean |
参数解释: 是否为第一个逻辑集群。历史版本中第1个创建或者转换的逻辑集群不能删除,因为其中包含了一些系统视图。 取值范围: 不涉及。 |
action_info |
ActionInfo object |
参数解释: 逻辑集群任务信息。 取值范围: 不涉及。 |
edit_enable |
Boolean |
参数解释: 是否允许编辑。 取值范围: 不涉及。 |
restart_enable |
Boolean |
参数解释: 是否允许重启。 取值范围: 不涉及。 |
delete_enable |
Boolean |
参数解释: 是否允许删除。 取值范围: 不涉及。 |
add_to_elastic |
Boolean |
参数解释: 是否允许弹性伸缩。 取值范围: 不涉及。 |
mode |
String |
参数解释: 逻辑集群模式。 取值范围: 不涉及。 |
waiting_for_killing |
Integer |
参数解释: 作业等待时间。 取值范围: 不涉及。 |
cluster_type |
String |
参数解释: 集群类型。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
ring_hosts |
Array of RingHost objects |
参数解释: 集群主机信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
un_shrinkable_cluster_ring |
Boolean |
参数解释: 是否可以缩容。 约束限制: 不涉及。 取值范围: false|true。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
host_name |
String |
参数解释: 主机名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
back_ip |
String |
参数解释: 后端IP地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
cpu_cores |
Integer |
参数解释: 主机CPU核数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
memory |
Double |
参数解释: 主机内存。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
disk_size |
Double |
参数解释: 主机磁盘大小。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
action_name |
String |
参数解释: 操作名称。 取值范围: Create:创建逻辑集群 Expand:扩容逻辑集群 Restart:重启逻辑集群 Delete:删除逻辑集群 Shrink:缩容逻辑集群 |
progress |
Integer |
参数解释: 操作进度,默认10。 取值范围: 0~100 |
completed |
Boolean |
参数解释: 操作是否完成。 取值范围: 不涉及。 |
start_time |
String |
参数解释: 操作开始时间。 取值范围: 不涉及。 |
end_time |
String |
参数解释: 操作结束时间。 取值范围: 不涉及。 |
result |
String |
参数解释: 操作结果。默认为空字符串。 取值范围: success:成功。 failed:失败。 |
logs |
String |
参数解释: 操作日志信息。 取值范围: 不涉及。 |
请求示例
查询逻辑集群列表。
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters
响应示例
状态码:200
查询集群列表成功。
{ "logical_clusters" : [ { "logical_cluster_id" : "fa9d69a0-3814-4fb9-98df-d9f4f5ef53ca", "logical_cluster_name" : "elastic_group", "cluster_rings" : [ { "ring_hosts" : [ { "host_name" : "host-172-16-20-246", "back_ip" : "172.16.73.90", "cpu_cores" : 8, "memory" : 32.0, "disk_size" : 800.0 }, { "host_name" : "host-172-16-4-26", "back_ip" : "172.16.123.5", "cpu_cores" : 8, "memory" : 32.0, "disk_size" : 800.0 }, { "host_name" : "host-172-16-43-90", "back_ip" : "172.16.92.175", "cpu_cores" : 8, "memory" : 32.0, "disk_size" : 800.0 } ], "un_shrinkable_cluster_ring" : true } ], "status" : "Normal", "first_logical_cluster" : false, "action_info" : { "progress" : 100, "completed" : true, "result" : "success", "logs" : null, "action_name" : "Grow", "start_time" : "2023-06-05 01:58:43", "end_time" : "2023-06-05 02:11:50" }, "edit_enable" : true, "restart_enable" : true, "delete_enable" : false, "add_to_elastic" : true, "mode" : null, "cluster_type" : null } ], "count" : 1, "add_enable" : true }
状态码
状态码 |
描述 |
---|---|
200 |
查询集群列表成功。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |