Querying the Cluster Node List - ListNodes

Function

This API is used to query the cluster node list.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v2/{project_id}/clusters/{cluster_id}/nodes

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation Project ID. Constraints N/A Value range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default value N/A
cluster_id	Yes	String	Explanation Cluster ID Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
node_group	No	String	Explanation Name of the node groups to be queried. Constraints N/A Value range The value can contain 3 to 14 characters. Default value N/A
limit	No	Integer	Explanation Number of records displayed on each page in the returned result. Constraints N/A Value range ≥1 Default value 10
offset	No	Integer	Explanation Offset from which the job list starts to be queried. Constraints N/A Value range ≥1 Default value 1
node_name	No	String	Explanation Node name. Fuzzy search is supported. Constraints N/A Value range N/A Default value N/A
sort_key	No	String	Explanation Sorting key. You can set node names as the key. Constraints N/A Value range node_name: node name Default value N/A
sort_dir	No	String	Explanation Sorting order. desc indicates descending order, and asc indicates ascending order. Constraints N/A Value range desc: descending order asc: ascending order Default value N/A
query_node_detail	No	Boolean	Explanation Whether to query node details. If this parameter is set to true, the interface performance may be affected. Constraints N/A Value range true: Query node details. false: Do not query node details. Default value false
query_ecs_detail	No	Boolean	Explanation Whether to query ECS details. ECS APIs may be called. Constraints N/A Value range true: Query ECS details. false: Do not query ECS details. Default value false
internal_ip	No	String	Explanation Internal IP address. Constraints N/A Value range The value can contain 7 to 15 characters. Default value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
nodes	Array of ClusterNode objects	Explanation Node list. For details, see Table 4. Constraints N/A Value range N/A Default value N/A
node_total	Integer	Explanation Number of nodes. Constraints N/A Value range N/A Default value N/A

**Table 4** ClusterNode
Parameter	Type	Description
node_name	String	Explanation Node name, which is the same as that on Manager. Constraints N/A Value range N/A Default value N/A
resource_id	String	Explanation Resource ID. Unique identity of a node. For yearly/monthly nodes, the ID can be used to query bills. Constraints N/A Value range N/A Default value N/A
node_group_name	String	Explanation Node group name. Constraints N/A Value range N/A Default value N/A
node_type	String	Explanation Node type. Available values include Task, Core, and Master. Constraints N/A Value range A cluster must contain Master nodes and may contain Core and Task nodes. Master: Master node Core: Core node Task: Task node Default value N/A
billing_type	String	Explanation on-period: yearly/monthly; on-quantity: pay-per-use. Constraints N/A Value range on-period: yearly/monthly on-quantity: pay-per-use Default value N/A
deployment_type	String	Explanation Deployment type. The Server hosts are supported. Constraints N/A Value range SERVER: Host type Default value N/A
server_info	ServerInfo object	Explanation If the deployment type is Server, this parameter cannot be empty. For details, see Table 5. Constraints N/A Value range N/A Default value N/A
tags	Array of Tag objects	Explanation Node tag. For details, see Table 7. Constraints N/A Value range N/A Default value N/A
node_detail	NodeDetail object	Explanation Node monitoring information. This parameter is returned only after IAM synchronization. For details, see Table 8. Constraints N/A Value range N/A Default value N/A
node_status	String	Explanation Node status. Status of operations on the corresponding page. Constraints N/A Value range error: The node is faulty. delete_fail: The node fails to be deleted. shutdown: The node is shut down. creating: The node is being created. starting: The node is being started. started: The node is running. deleting: The node is being deleted. powering-on: The node is being powered on. powering-off: The node is being powered off. stopping: The node is being stopped. attaching: The node is being unisolated. attached: The node is unisolated. detaching: The node is being isolated. detached: The node is isolated. detached_no_subscription: The node is unbound. detach_fail: The node fails to be isolated. destroyed: The node is deleted. lost: The node is disconnected. unknown: The node status is unknown. scaling-up: The node is being scaled up. decommissioning: The node is being decommissioned. decommissioned: The node is decommissioned. recommissioning: The node is being recommissioned. decommission_fail: The node fails to be decommissioned. restore_fail: The node fails to be restored. Default value N/A
component_infos	Array of ComponentInfo objects	Explanation Component instance information array. For details, see Table 9. Constraints N/A Value range N/A Default value N/A

**Table 5** ServerInfo
Parameter	Type	Description
server_id	String	Explanation Server ID. Constraints N/A Value range N/A Default value N/A
server_name	String	Explanation Server name. Constraints N/A Value range N/A Default value N/A
server_type	String	Explanation Server type. Available options are ECS and BMS. Constraints N/A Value range ECS: Elastic Cloud Server BMS: Bare Metal Server Default value N/A
data_volumes	Array of VolumeInfo objects	Explanation Data disk. For details, see Table 6. Constraints N/A Value range N/A Default value N/A
root_volume	VolumeInfo object	Explanation System disk. For details, see Table 6. Constraints N/A Value range N/A Default value N/A
cpu_type	String	Explanation CPU type. Available options are x86 and Arm. Constraints N/A Value range x86: x86 architecture ARM: Arm architecture Default value N/A
cpu	String	Explanation Number of vCPUs. Constraints N/A Value range N/A Default value N/A
mem	String	Explanation Memory size. Constraints N/A Value range N/A Default value N/A
internal_ip	String	Explanation Internal IP address. Constraints N/A Value range N/A Default value N/A

**Table 6** VolumeInfo
Parameter	Type	Description
type	String	Explanation Disk type. Constraints N/A Value range SATA: common I/O disk SAS: high I/O disk SSD: ultra-high I/O disk GPSSD: general-purpose SSD disk Default value N/A
size	Integer	Explanation Disk size. Unit: GB. Constraints N/A Value range N/A Default value N/A
count	Integer	Explanation Disk quantity. Constraints N/A Value range N/A Default value N/A

**Table 7** Tag
Parameter	Type	Description
key	String	Explanation Tag key Constraints N/A Value range N/A Default value N/A
value	String	Explanation Tag value. Constraints N/A Value range N/A Default value N/A

**Table 8** NodeDetail
Parameter	Type	Description
running_status	String	Explanation Running status. Constraints N/A Value range GOOD: The node is running properly. BAD: The node is faulty. UNKNOWN: The node status is unknown. CONCERNING: The node is being restored. ISOLATED: The node is isolated. SUSPENDED: The node is suspended. Default value N/A
cpu_usage	String	Explanation CPU utilization rate. Constraints N/A Value range N/A Default value N/A
memory_usage	String	Explanation Memory utilization rate. Constraints N/A Value range N/A Default value N/A
disk_usage	String	Explanation Disk usage. Constraints N/A Value range N/A Default value N/A
total_memory	String	Explanation Total memory. Unit: MB. Constraints N/A Value range N/A Default value N/A
available_memory	String	Explanation Available memory. Unit: MB. Constraints N/A Value range N/A Default value N/A
total_hard_disk_space	String	Explanation Total hard disk space. Unit: GB Constraints N/A Value range N/A Default value N/A
available_hard_disk_space	String	Explanation Available hard disk space. Unit: GB Constraints N/A Value range N/A Default value N/A
network_read	String	Explanation Network read speed. Unit: Byte/s Constraints N/A Value range N/A Default value N/A
network_write	String	Explanation Network write speed. Unit: Byte/s Constraints N/A Value range N/A Default value N/A

**Table 9** ComponentInfo
Parameter	Type	Description
id	String	Explanation Component ID Constraints N/A Value range N/A Default value N/A
name	String	Explanation Component name Constraints N/A Value range N/A Default value N/A
instance_group_name	String	Explanation Name of the group to which the component belongs. Constraints N/A Value range N/A Default value N/A
running_status	String	Explanation Running status. Constraints N/A Value range GOOD: The component is running properly. BAD: The component is faulty. UNKNOWN: The component status is unknown. CONCERNING: The component is being restored. ISOLATED: The component is isolated. SUSPENDED: The component is suspended. Default value N/A
ha_status	String	Explanation HA status. Constraints N/A Value range ACTIVE: Active STANDBY: Standby OBSERVER: Secondary UNKNOWN: Unknown Default value N/A
config_status	String	Explanation Configuration status. Constraints N/A Value range SYNCHRONIZED: Synchronized EXPIRED: Configuration expired FAILED: Configuration failed CONFIGURING: Configuration in progress UNKNOWN: Unknown Default value N/A
role_name	String	Explanation Role name. Constraints N/A Value range N/A Default value N/A
role_short_name	String	Explanation Abbreviation of a role name. Constraints N/A Value range N/A Default value N/A
role_type	String	Explanation Role type. Constraints N/A Value range N/A Default value N/A
service_name	String	Explanation Service name. Constraints N/A Value range N/A Default value N/A
pair_name	String	Explanation Pair name. Constraints N/A Value range N/A Default value N/A
relation_pairs	String	Explanation Associated pair Constraints N/A Value range N/A Default value N/A
support_decom	String	Explanation Whether Decom is supported. Constraints N/A Value range N/A Default value N/A
support_reinstall	String	Explanation Whether reinstallation is supported. Constraints N/A Value range N/A Default value N/A
support_collect_stack_info	String	Explanation Whether stack information can be collected. Constraints N/A Value range N/A Default value N/A

Example Request

Query all nodes in a specified node group of a cluster.

/v2/174ee662a7e24cc99bfc858c4558dbf6/clusters/f0a91b14-8884-4ba1-9e8d-0a21086c0ab4/nodes?node_group=master_node_default_group

Example Response

Status code: 200

List node information.

{
  "nodes" : [ {
    "node_name" : "node-master1QxCW",
    "resource_id" : "fc1ed6bb-e3d8-4dc8-8162-ef673bff6b7b",
    "node_group_name" : "master_node_default_group",
    "node_type" : "Master",
    "billing_type" : "on-quantity",
    "deployment_type" : "SERVER",
    "server_info" : {
      "server_id" : "3687f50a-cd4e-4c67-8858-5d6555c8834c",
      "server_name" : "f28fb043-ecbc-401e-936e-fb321ca8d40a_node_master1QxCW",
      "server_type" : "ECS",
      "data_volumes" : [ {
        "type" : "SATA",
        "size" : 200,
        "count" : 1
      } ],
      "root_volume" : {
        "type" : "SATA",
        "size" : 100,
        "count" : 1
      },
      "cpu_type" : "X86",
      "internal_ip" : "192.168.10.142"
    },
    "tags" : [ {
      "key" : "1",
      "value" : "2"
    } ],
    "node_status" : "started"
  } ],
  "node_total" : 1
}

Status Codes

Status Codes	Description
200	List of queried nodes.

Error Codes

For details, see Error Codes.

Parent topic:Cluster Management APIs

Previous topic: Adding Components to a Cluster - AddComponent

Next topic: Job Management APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot