调用DescribeClusterNodes查询集群节点。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

get /clusters/{ClusterId}/nodes http|https

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String c82e6987e2961451182edacd74faf****

集群ID。

pageSize String 3

分页大小。

pageNumber String 50

展示分页数。

nodepool_id String np***

节点池ID。

state String all

集群状态,按照集群运行状态进行过滤,取值:

  • all:以下4种状态的集群。
  • running:正在运行的集群。
  • removing:正在删除的集群。
  • initial:正在初始化的集群。
  • failed:创建失败的集群。

返回数据

名称 类型 示例值 描述
nodes Array of node

节点详情列表。

creation_time String "2020-08-25T11:25:35+08:00"

节点创建时间。

error_message String "***"

节点创建时错误信息。

expired_time String "2099-12-31T23:59:00+08:00"

节点到期时间。

host_name String "iZ2vcckdmxp7u0urj2k****"

节点主机名。

image_id String "aliyun_2_1903_x64_20G_alibase_20200529.vhd"

节点使用的系统镜像ID。

instance_charge_type String "PostPaid"

节点付费类型。

instance_id String "i-2vcckdmxp7u0urj2k2rw"

节点实例ID。

instance_name String "worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****"

节点在集群中的名称。

instance_role String "Worker"

节点角色类型:

  • Master:集群Master节点。
  • Worker:集群Worker节点。
instance_status String "Running"

节点运行状态。

instance_type String "ecs.c5.xlarge"

节点类型。

instance_type_family String "ecs.c5"

节点所属ECS族名称。

ip_address Array of String

节点IP地址。

is_aliyun_node Boolean "true"

是否为阿里云实例。

node_name String "cn-chengdu.192.168.0.36"

节点名称,集群内节点标识。

node_status String "Ready"

节点是否就绪。

nodepool_id String "np0794239424a84eb7a95327369d56****"

节点池ID。

source String "ess_attach"

节点通过什么初始化出来的,例如:手动创建或这ROS创建。

state String "running"

节点运行状态。

page Object

分页信息。

page_number Integer "1"

分页数。

page_size Integer "10"

单页大小。

total_count Integer "5"

结果总数。

示例

请求示例

GET /clusters/[ClusterId]/nodes HTTP/1.1
公共请求头
{
    "ClusterId":" c82e6987e2961451182edacd74faf****"
}

正常返回示例

XML 格式

<nodes>
    <creation_time>2020-08-25T11:25:35+08:00</creation_time>
    <error_message/>
    <instance_name>worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****</instance_name>
    <node_status>Ready</node_status>
    <is_aliyun_node>true</is_aliyun_node>
    <node_name>cn-chengdu.192.168.0.36</node_name>
    <expired_time>2099-12-31T23:59:00+08:00</expired_time>
    <ip_address>192.168.0.36</ip_address>
    <source>ess_attach</source>
    <instance_type_family>ecs.c5</instance_type_family>
    <instance_id>i-2vcckdmxp7u0urj2k2rw</instance_id>
    <instance_charge_type>PostPaid</instance_charge_type>
    <instance_role>Worker</instance_role>
    <instance_status>Running</instance_status>
    <state>running</state>
    <image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>
    <instance_type>ecs.c5.xlarge</instance_type>
    <nodepool_id>np0794239424a84eb7a95327369d56****</nodepool_id>
    <host_name>iZ2vcckdmxp7u0urj2k****</host_name>
</nodes>
<page>
    <page_number>1</page_number>
    <total_count>5</total_count>
    <page_size>10</page_size>
</page>

JSON 格式

{
    "nodes": [
        {
            "creation_time": "2020-08-25T11:25:35+08:00",
            "error_message": "",
            "instance_name": "worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****",
            "node_status": "Ready",
            "is_aliyun_node": "true",
            "node_name": "cn-chengdu.192.168.0.36",
            "expired_time": "2099-12-31T23:59:00+08:00",
            "ip_address": "192.168.0.36",
            "source": "ess_attach",
            "instance_type_family": "ecs.c5",
            "instance_id": "i-2vcckdmxp7u0urj2k2rw",
            "instance_charge_type": "PostPaid",
            "instance_role": "Worker",
            "instance_status": "Running",
            "state": "running",
            "image_id": "aliyun_2_1903_x64_20G_alibase_20200529.vhd",
            "instance_type": "ecs.c5.xlarge",
            "nodepool_id": "np0794239424a84eb7a95327369d56****",
            "host_name": "iZ2vcckdmxp7u0urj2k****"
        }
    ],
    "page": {
        "page_number": "1",
        "total_count": "5",
        "page_size": "10"
    }
}

错误码

访问错误中心查看更多错误码。