You can call DescribeClusterNodes to query nodes in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses the common request header only. For more information, see Common parameters.

Request syntax

GET /clusters/[ClusterId]/nodes HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
ClusterId String Yes c82e6987e2961451182edacd74faf****

The ID of the cluster.

pageSize String No 30

The number of entries to return on each page.

pageNumber String No 15

The total number of pages to return.

nodepool_id String No ""

The ID of the node pool.

state String No ""

The status of the cluster.

Response parameters

Parameter Type Example Description
nodes Array

A list of nodes in the cluster.

creation_time String 2020-03-11T11:09:00+08:00

The time when the node was created.

error_message String ""

The error message about exceptions on the node.

expired_time String 2025-12-31T23:59:00+08:00

The time when the node expires.

host_name String iZ2ze3ig3sqoxhr67s5a0xZ

The name of the host.

image_id String centos_7_7_x64_20G_alibase_20191225.vhd

The ID of the operating system image used by the node.

instance_charge_type String PostPaid

The billing method of the node.

instance_id String i-2ze13ykcubmcxhnhqh54

The ID of the node.

instance_name String master-01-k8s-for-cs-c264e854539f843298989ea8d6a9cff8a

The instance name assigned by the cluster.

instance_role String Master

The role of the node. Valid values:

  • Master
  • Worker
instance_status String Running

The running status of the node.

instance_type String ecs.c5.xlarge

The ECS instance type of the node.

instance_type_family String ecs.c5

The ECS instance family of the node.

ip_address List []

The IP address of the node.

is_aliyun_node Boolean true

Indicates whether the node is provided by Alibaba Cloud.

node_name String cn-hangzhou.172.16.1.62

The name of the node.

node_status String Ready

Indicates whether the node is ready.

nodepool_id String npcaf85bf809754dfa91cd63e80460****

The ID of the node pool.

source String ros

The source of the node. Default value: ros.

state String running

The running status of the node.

page Struct

The pagination details.

page_number Integer 137

The total number of pages returned.

page_size Integer 1

The number of entries returned per page.

total_count Integer 6

The total number of entries returned.

Examples

Sample requests

GET /clusters/[ClusterId]/nodes HTTP/1.1
Common request header
{
"ClusterId": " c82e6987e2961451182edacd74faf****"
}

Sample success responses

XML format

<nodes>
    <error_message>""</error_message>
    <creation_time>2020-03-11T11:09:00+08:00</creation_time>
    <instance_name>master-01-k8s-for-cs-c264e854539f843298989ea8d6a9c****</instance_name>
    <node_status>Ready</node_status>
    <is_aliyun_node>true</is_aliyun_node>
    <node_name>cn-hangzhou.172.16.1.62</node_name>
    <expired_time>2025-12-31T23:59:00+08:00</expired_time>
    <source>ros</source>
    <instance_type_family>ecs.c5</instance_type_family>
    <instance_id>i-2ze13ykcubmcxhnh****</instance_id>
    <instance_charge_type>PostPaid</instance_charge_type>
    <instance_role>Master</instance_role>
    <state>running</state>
    <instance_status>Running</instance_status>
    <image_id>centos_7_7_x64_20G_alibase_20191225.vhd</image_id>
    <instance_type>ecs.c5.xlarge</instance_type>
    <nodepool_id>npcaf85bf809754dfa91cd63e80460****</nodepool_id>
    <host_name>iZ2ze3ig3sqoxhr67s5****</host_name>
</nodes>
<nodes>
    <ip_address>[]</ip_address>
</nodes>
<page>
    <page_number>137</page_number>
    <total_count>6</total_count>
    <page_size>1</page_size>
</page>

JSON format

{"nodes":[{"error_message":"\"\"","creation_time":"2020-03-11T11:09:00+08:00","instance_name":"master-01-k8s-for-cs-c264e854539f843298989ea8d6a9c****","node_status":"Ready","is_aliyun_node":"true","node_name":"cn-hangzhou.172.16.1.62","expired_time":"2025-12-31T23:59:00+08:00","source":"ros","instance_type_family":"ecs.c5","instance_id":"i-2ze13ykcubmcxhnh****","instance_charge_type":"PostPaid","instance_role":"Master","state":"running","instance_status":"Running","image_id":"centos_7_7_x64_20G_alibase_20191225.vhd","instance_type":"ecs.c5.xlarge","nodepool_id":"npcaf85bf809754dfa91cd63e80460****","host_name":"iZ2ze3ig3sqoxhr67s5a0xZ"},{"ip_address":"[]"}],"page":{"page_number":"137","total_count":"6","page_size":"1"}}

Error codes

For a list of error codes, visit the API Error Center.