全部产品
Search
文档中心

容器服务 Kubernetes 版 ACK:DescribeClusterNodes - 查询集群节点列表

更新时间:Feb 29, 2024

您可以调用DescribeClusterNodes接口,查询符合条件的节点列表信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeClusterNodesRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

GET /clusters/{ClusterId}/nodes

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

c82e6987e2961451182edacd74faf****
instanceIdsstring

节点实例 ID 列表,多值使用英文逗号(,)分隔。

"i-bp11xjhwkj8k966u****,i-bp1dmhc2bu5igkyq****"
nodepool_idstring

节点池 ID。

np****
statestring

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

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

默认值:all

running
pageSizestring

每页显示的记录数。取值范围为[1,100]。

默认值:10。

10
pageNumberstring

页码。

默认值:1。

1

返回参数

名称类型描述示例值
object

返回数据体。

nodesobject []

节点详情列表。

creation_timestring

节点创建时间。

2020-08-25T11:25:35+08:00
error_messagestring

节点创建时错误信息。

error***
expired_timestring

节点到期时间。

2099-12-31T23:59:00+08:00
host_namestring

节点主机名。

iZ2vcckdmxp7u0urj2k****
image_idstring

节点使用的系统镜像 ID。

aliyun_2_1903_x64_20G_alibase_20200529.vhd
instance_charge_typestring

节点付费类型。取值:

  • PrePaid:预付费,包年包月。选择该类付费方式时,您必须确认自己的账号支持余额支付或信用支付,否则将返回InvalidPayMethod的错误提示。

  • PostPaid:按量付费。

PostPaid
instance_idstring

节点实例 ID。

i-2vcckdmxp7u0urj2****
instance_namestring

节点在集群中的名称。

worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****
instance_rolestring

节点角色类型:

  • Master:集群 Master 节点。
  • Worker:集群 Worker 节点。
Worker
instance_statusstring

节点运行状态。

Running
instance_typestring

节点类型。

ecs.c5.xlarge
instance_type_familystring

节点所属 ECS 族名称。

ecs.c5
ip_addressarray

节点 IP 地址。

string

IP 地址。

192.168.0.36
is_aliyun_nodeboolean

是否为阿里云实例。取值:

  • true:是阿里云实例。

  • false:不是阿里云实例。

true
node_namestring

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

cn-chengdu.192.168.0.36
node_statusstring

节点是否就绪。取值:

  • Ready:节点已就绪。

  • NotReady:节点未就绪。

  • Unknown:未知。

  • Offline:离线中。

Ready
nodepool_idstring

节点池 ID。

np0794239424a84eb7a95327369d56****
sourcestring

节点通过何种方式初始化,例如:手动创建或 ROS 创建。

ess_attach
statestring

节点运行状态。取值:

  • pending:创建中。

  • running:运行中。

  • starting:启动中。

  • stopping:停止中。

  • stopped:已停止。

running
spot_strategystring

抢占式实例类型,取值:

  • NoSpot:非抢占式实例。
  • SpotWithPriceLimit:设置抢占实例价格上限。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
NoSpot
pageobject

分页信息。

page_numberinteger

页码。

1
page_sizeinteger

每页显示的记录数。

10
total_countinteger

结果总数。

5

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史