DescribeClusterNodes
获取集群的节点信息
请求参数
Parameter name | Type | Description | Required |
---|---|---|---|
cluster |
String |
集群ID |
Yes |
cluster_nodes.n |
String |
集群节点ID |
No |
role |
String |
集群节点角色 |
No |
verbose |
Integer |
是否返回冗长的信息,目前 verbose 只支持为 0。 |
No |
offset |
Integer |
数据偏移量,默认为0 |
No |
limit |
Integer |
返回数据长度,默认为20,最大100 |
No |
reverse |
Integer |
是否逆序,1为逆序,0为正序 |
No |
除上述请求参数外,还包含公共参数。
返回数据
Name | Type | Description |
---|---|---|
action |
String |
响应动作 |
total_count |
Integer |
节点的总数量 |
node_set |
Array |
JSON格式的节点列表 |
ret_code |
Integer |
执行成功与否,0 表示成功,其他值则为错误代码 |
Response Item
Name | Type | Description |
---|---|---|
app_id |
String |
应用ID |
node_id |
String |
节点ID |
group_id |
Integer |
节点所在的 Group ID |
cluster_id |
String |
集群ID |
vxnet_id |
String |
节点所在网络ID |
private_ip |
String |
节点的私有IP地址 |
role |
String |
节点的角色 |
name |
String |
节点名称 |
memory |
Integer |
节点的内存大小,单位MB |
app_version |
String |
应用版本ID |
status |
String |
节点的状态,active |
storage_size |
Integer |
节点的存储大小,单位GB |
image_id |
String |
节点的镜像ID |
eip |
String |
节点绑定的公网或基础网络IP |
volume_type |
Integer |
节点存储类型,具体参加开发者文档 |
instance_id |
String |
节点的云服务器ID |
instance_type |
String |
节点的云服务器类型 |
security_group |
String |
节点绑定的防火墙ID |
cpu |
Integer |
节点的CPU |
health_status |
String |
节点的健康状态,healthy或unhealthy |
env |
String |
JSON格式的环境变量值,具体参见开发者文档mustache |
vertical_scaling_policy |
String |
节点纵向扩容配置,sequential表示依次扩容,parallel表示同时扩容 |
advanced_actions |
String |
节点支持的操作,change_vxnet表示切换私网,scael_horizontal表示横向扩容 |
agent_installed |
boolen |
节点是否安装青云的agent |
user_access |
Integer |
节点是否支持用户VNC登录,0表示不支持 |
gpu_class |
Integer |
节点是否支持gpu,0表示不支持,1表示支持 |
gpu |
Integer |
节点的gpu数量,0表示当前节点没有gpu |
single_node_repl |
String |
|
backup_policy |
String |
备份策略 |
incremental_backup_supported |
boolen |
是否支持增量备份 |
resource_class |
Integer |
节点的资源类型 |
hypervisor |
Integer |
节点的虚拟化类型,当前支持kvm |
health_check |
String |
JSON格式的健康检查配置 |
monitor |
String |
JSON格式的数据监控配置 |
init_service |
String |
JSON格式的初始化命令,具体参见开发者文档 |
start_service |
String |
JSON格式的启动命令,具体参见开发者文档 |
stop_service |
String |
JSON格式的停止命令,具体参见开发者文档 |
restart_service |
String |
JSON格式的重启命令,具体参见开发者文档 |
scale_in_service |
String |
JSON格式的删除节点命令,具体参见开发者文档 |
scale_out_service |
String |
JSON格式的增加节点命令,具体参见开发者文档 |
destroy_service |
String |
JSON格式的销毁命令,具体参见开发者文档 |
restore_service |
String |
JSON格式的停止命令,具体参见开发者文档 |
delete_snapshot_service |
String |
JSON格式的删除备份命令,具体参见开发者文档 |
custom_metadata_script |
String |
JSON格式的自定义metadata脚本,具体参见开发者文档 |
display_tabs |
String |
JSON格式的display tabs命令,具体参见开发者文档 |
backup_service |
String |
JSON格式的备份命令,具体参见开发者文档 |
create_time |
TimeStamp |
日志创建时间,为UTC时间,格式可参见 ISO8601. |
以应用https://appcenter.qingcloud.com/apps/app-tg3lbp0a/ZooKeeper%20on%20QingCloud[ZooKeeper]创建的集群为例
请求示例
https://api.qingcloud.com/iaas/?action=DescribeClusterNodes
&cluster=cl-q1witcdk
&limit=20
&reverse=1
&zone=pke3b
&COMMON_PARAMS
返回示例
{
"action":"DescribeClusterNodesResponse",
"total_count":3,
"node_set":[
{
"passphraseless":"",
"vertical_scaling_policy":"sequential",
"vxnet_id":"vxnet-pmefzgi",
"destroy_service":null,
"custom_service":null,
"app_id":"app-tg3lbp0a",
"advanced_actions":"change_vxnet,scale_horizontal",
"agent_installed":true,
"stop_service":{
"cmd":"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop",
"order":0
},
"user_access":0,
"create_time":"2018-03-04T06:00:15Z",
"cluster_id":"cl-q1witcdk",
"private_ip":"192.168.0.3",
"upgrade_service":null,
"gpu_class":0,
"restore_service":null,
"monitor":{
"enable":true,
"items":{
"received":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"avg":{
"scale_factor_when_display":1,
"statistics_type":"avg",
"value_type":"int",
"unit":"ms"
},
"outstanding":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"max":{
"scale_factor_when_display":1,
"statistics_type":"max",
"value_type":"int",
"unit":"ms"
},
"min":{
"scale_factor_when_display":1,
"statistics_type":"min",
"value_type":"int",
"unit":"ms"
},
"mode":{
"value_type":"str",
"enums":[
"L",
"F",
"S"
],
"statistics_type":"latest",
"unit":""
},
"active":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"znode":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"znode_count"
},
"sent":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
}
},
"alarm":[
"avg"
],
"cmd":"/opt/zookeeper/bin/get-monitor.sh",
"groups":{
"connections":[
"active",
"outstanding"
],
"latency":[
"min",
"avg",
"max"
],
"throughput":[
"received",
"sent"
]
},
"display":[
"mode",
"latency",
"throughput",
"connections",
"znode"
]
},
"single_node_repl":"",
"health_status":"healthy",
"role":"",
"incremental_backup_supported":false,
"env":null,
"memory":2048,
"status_time":"2018-03-04T06:02:04Z",
"restart_service":null,
"app_version":"appv-70gegwmp",
"status":"active",
"health_check":{
"enable":true,
"timeout_sec":10,
"healthy_threshold":2,
"interval_sec":60,
"unhealthy_threshold":2,
"check_cmd":"echo srvr | nc 127.0.0.1 2181",
"action_cmd":"/opt/zookeeper/bin/restart-server.sh",
"action_timeout_sec":30
},
"scale_in_service":null,
"transition_status":"",
"storage_size":10,
"server_id_upper_bound":255,
"image_id":"img-svm7yple",
"init_service":null,
"repl":"rpp-00000000",
"gpu":0,
"name":"",
"eip":"",
"start_service":{
"cmd":"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start",
"order":0
},
"resource_class":0,
"hypervisor":"kvm",
"delete_snapshot_service":null,
"volume_type":0,
"instance_id":"i-blny8gpg",
"instance_type":"",
"scale_out_service":null,
"node_id":"cln-35iuqdjz",
"custom_metadata_script":null,
"security_group":"",
"alarm_status":"",
"backup_policy":null,
"group_id":1,
"backup_service":null,
"cpu":1,
"display_tabs":null
},
{
"passphraseless":"",
"vertical_scaling_policy":"sequential",
"vxnet_id":"vxnet-pmefzgi",
"destroy_service":null,
"custom_service":null,
"app_id":"app-tg3lbp0a",
"advanced_actions":"change_vxnet,scale_horizontal",
"agent_installed":true,
"stop_service":{
"cmd":"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop",
"order":0
},
"user_access":0,
"create_time":"2018-03-04T06:00:15Z",
"cluster_id":"cl-q1witcdk",
"private_ip":"192.168.0.2",
"upgrade_service":null,
"gpu_class":0,
"restore_service":null,
"monitor":{
"enable":true,
"items":{
"received":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"avg":{
"scale_factor_when_display":1,
"statistics_type":"avg",
"value_type":"int",
"unit":"ms"
},
"outstanding":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"max":{
"scale_factor_when_display":1,
"statistics_type":"max",
"value_type":"int",
"unit":"ms"
},
"min":{
"scale_factor_when_display":1,
"statistics_type":"min",
"value_type":"int",
"unit":"ms"
},
"mode":{
"value_type":"str",
"enums":[
"L",
"F",
"S"
],
"statistics_type":"latest",
"unit":""
},
"active":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"znode":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"znode_count"
},
"sent":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
}
},
"alarm":[
"avg"
],
"cmd":"/opt/zookeeper/bin/get-monitor.sh",
"groups":{
"connections":[
"active",
"outstanding"
],
"latency":[
"min",
"avg",
"max"
],
"throughput":[
"received",
"sent"
]
},
"display":[
"mode",
"latency",
"throughput",
"connections",
"znode"
]
},
"single_node_repl":"",
"health_status":"healthy",
"role":"",
"incremental_backup_supported":false,
"env":null,
"memory":2048,
"status_time":"2018-03-04T06:01:58Z",
"restart_service":null,
"app_version":"appv-70gegwmp",
"status":"active",
"health_check":{
"enable":true,
"timeout_sec":10,
"healthy_threshold":2,
"interval_sec":60,
"unhealthy_threshold":2,
"check_cmd":"echo srvr | nc 127.0.0.1 2181",
"action_cmd":"/opt/zookeeper/bin/restart-server.sh",
"action_timeout_sec":30
},
"scale_in_service":null,
"transition_status":"",
"storage_size":10,
"server_id_upper_bound":255,
"image_id":"img-svm7yple",
"init_service":null,
"repl":"rpp-00000000",
"gpu":0,
"name":"",
"eip":"",
"start_service":{
"cmd":"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start",
"order":0
},
"resource_class":0,
"hypervisor":"kvm",
"delete_snapshot_service":null,
"volume_type":0,
"instance_id":"i-x6uksame",
"instance_type":"",
"scale_out_service":null,
"node_id":"cln-oruuckuo",
"custom_metadata_script":null,
"security_group":"",
"alarm_status":"",
"backup_policy":null,
"group_id":2,
"backup_service":null,
"cpu":1,
"display_tabs":null
},
{
"passphraseless":"",
"vertical_scaling_policy":"sequential",
"vxnet_id":"vxnet-pmefzgi",
"destroy_service":null,
"custom_service":null,
"app_id":"app-tg3lbp0a",
"advanced_actions":"change_vxnet,scale_horizontal",
"agent_installed":true,
"stop_service":{
"cmd":"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop",
"order":0
},
"user_access":0,
"create_time":"2018-03-04T06:00:15Z",
"cluster_id":"cl-q1witcdk",
"private_ip":"192.168.0.4",
"upgrade_service":null,
"gpu_class":0,
"restore_service":null,
"monitor":{
"enable":true,
"items":{
"received":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"avg":{
"scale_factor_when_display":1,
"statistics_type":"avg",
"value_type":"int",
"unit":"ms"
},
"outstanding":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"max":{
"scale_factor_when_display":1,
"statistics_type":"max",
"value_type":"int",
"unit":"ms"
},
"min":{
"scale_factor_when_display":1,
"statistics_type":"min",
"value_type":"int",
"unit":"ms"
},
"mode":{
"value_type":"str",
"enums":[
"L",
"F",
"S"
],
"statistics_type":"latest",
"unit":""
},
"active":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
},
"znode":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"znode_count"
},
"sent":{
"scale_factor_when_display":1,
"statistics_type":"latest",
"value_type":"int",
"unit":"count"
}
},
"alarm":[
"avg"
],
"cmd":"/opt/zookeeper/bin/get-monitor.sh",
"groups":{
"connections":[
"active",
"outstanding"
],
"latency":[
"min",
"avg",
"max"
],
"throughput":[
"received",
"sent"
]
},
"display":[
"mode",
"latency",
"throughput",
"connections",
"znode"
]
},
"single_node_repl":"",
"health_status":"healthy",
"role":"",
"incremental_backup_supported":false,
"env":null,
"memory":2048,
"status_time":"2018-03-04T06:01:59Z",
"restart_service":null,
"app_version":"appv-70gegwmp",
"status":"active",
"health_check":{
"enable":true,
"timeout_sec":10,
"healthy_threshold":2,
"interval_sec":60,
"unhealthy_threshold":2,
"check_cmd":"echo srvr | nc 127.0.0.1 2181",
"action_cmd":"/opt/zookeeper/bin/restart-server.sh",
"action_timeout_sec":30
},
"scale_in_service":null,
"transition_status":"",
"storage_size":10,
"server_id_upper_bound":255,
"image_id":"img-svm7yple",
"init_service":null,
"repl":"rpp-00000000",
"gpu":0,
"name":"",
"eip":"",
"start_service":{
"cmd":"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start",
"order":0
},
"resource_class":0,
"hypervisor":"kvm",
"delete_snapshot_service":null,
"volume_type":0,
"instance_id":"i-aib1f523",
"instance_type":"",
"scale_out_service":null,
"node_id":"cln-yrlus78f",
"custom_metadata_script":null,
"security_group":"",
"alarm_status":"",
"backup_policy":null,
"group_id":3,
"backup_service":null,
"cpu":1,
"display_tabs":null
}
],
"ret_code":0
}