调用DescribeClusterNodePools查询集群内所有节点池详情。

调试

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

请求头

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

请求语法

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

请求参数

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

集群ID。

返回数据

名称 类型 示例值 描述
nodepools Array of nodepools

节点池详情列表。

auto_scaling Object

自动伸缩配置。

eip_bandwidth Long "5"

EIP带宽峰值。

eip_internet_charge_type String "***"

EIP付费类型。

enable Boolean "true"

是否绑定EIP。

health_check_type String "***"

自动伸缩节点健康检查方式。

max_instances Long "10"

最大实例数。

min_instances Long "2"

最小实例数。

type String "cpu"

自动扩容节点类型。

kubernetes_config Object

集群配置。

cms_enabled Boolean "true"

是否开启云监控。

cpu_policy String "none"

CPU管理策略,取值:static或none。

labels Array of labels

ECS标签。

key String "k-aa"

标签key。

value String "v-aa"

标签值。

node_name_mode String "nodeip"

节点命名策略。

overwrite_hostname Boolean "false"

是否覆盖主机名。

runtime String "docker"

容器运行时。

runtime_version String "19.03.5"

容器运行时版本。

taints Array of taints

污点配置。

effect String "NoSca"

污点策略。

key String "k-bb"

污点key。

value String "v-bb"

污点值。

user_data String "***"

节点自定义数据。

nodepool_info Object

节点池信息

created String "2020-09-27T19:14:09.156823496+08:00"

节点池创建时间。

is_default Boolean "true"

是否默认节点池。

name String "default-nodepool"

节点池名称。

nodepool_id String "np615c0e0966124216a0412e10afe0****"

节点池ID。

region_id String "cn-beijing"

地域ID。

resource_group_id String "***"

资源组ID。

type String "ess"

节点类型。

updated String "2020-09-27T20:37:46+08:00"

集群更新时间。

scaling_group Object

扩容组配置。

auto_renew Boolean "false"

节点是否开启自动续费,当instance_charge_type取值为PrePaid时才生效,可选值为:

  • true:自动续费。
  • false:不自动续费。
auto_renew_period Long "0"

节点自动续费周期,当选择预付费和自动续费时才生效,且为必选值: PeriodUnit=Month时,取值{“1”, “2”, “3”, “6”, “12”}。

data_disks Array of data_disks

节点数据盘配置。

category String "cloud_efficiency"

节点数据盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
encrypted String "false"

数据盘是否加密。

size Long "40"

数据盘大小。

image_id String "aliyun_2_1903_x64_20G_alibase_20200529.vhd"

自定义镜像ID。

instance_charge_type String "PostPaid"

节点付费类型,可选值为:

  • PrePaid:预付费
  • PostPaid:按量付费

默认为按量付费。

instance_types Array of String "ecs.n4.large"

节点实例规格列表。

multi_az_policy String "BALANCE"

多可用区策略。

period Long "0"

节点包年包月时长,当master_instance_charge_type取值为PrePaid时才生效且为必选值,取值范围: PeriodUnit=Month时,Period取值:{ “1”, “2”, “3”,“6”,“12”}。

period_unit String "*"

Master节点付费周期,当指定为PrePaid的时候需要指定周期。Month:以月为计时单位。

platform String "AliyunLinux"

操作系统发行版。取值范围:

CentOS

AliyunLinux

Windows

WindowsCore

ram_policy String "KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****"

RAM 角色名称。

rds_instances Array of String

RDS实例列表。

scaling_group_id String "***"

扩容组ID。

scaling_policy String "release"

扩容策略。

security_group_id String "sg-2ze1iuk12m2sb4c4****"

安全组ID。

system_disk_category String "cloud_efficiency"

节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
system_disk_size Long "120"

节点系统盘大小。

tags Array of tags

节点标签。

key String "k-cc"

标签key。

value String "v-cc"

标签值。

vswitch_ids Array of String

虚拟交换机列表。

worker_hpc_cluster_id String "***"

高性能计算集群ID。

status Object

节点池状态信息。

failed_nodes Long "0"

失败实例数。

healthy_nodes Long "3"

处于健康状态实例数。

initial_nodes Long "0"

正在创建的节点数。

offline_nodes Long "0"

离线节点数。

removing_nodes Long "0"

正在被移除的节点数。

serving_nodes Long "3"

处于工作状态的节点数

state String "active"

节点池状态。

total_nodes Long "3"

节点总数。

tee_config Object

加密计算配置。

tee_enable Boolean "false"

是否为加密计算节点池。

示例

请求示例

POST /clusters/{ClusterId}/nodepools HTTP/1.1
{
    "ClusterId":"c61da77e8bfbc4c4c999af2b51b65****"
}

正常返回示例

XML 格式

<nodepools>
      <tee_config>
            <tee_enable>false</tee_enable>
      </tee_config>
      <scaling_group>
            <instance_types>ecs.n4.large</instance_types>
            <scaling_group_id>***</scaling_group_id>
            <auto_renew_period>0</auto_renew_period>
            <period>0</period>
            <period_unit>*</period_unit>
            <security_group_id>sg-2ze1iuk12m2sb4c4****</security_group_id>
            <multi_az_policy>BALANCE</multi_az_policy>
            <system_disk_size>120</system_disk_size>
            <platform>AliyunLinux</platform>
            <tags>
                  <value>v-cc</value>
                  <key>k-cc</key>
            </tags>
            <worker_hpc_cluster_id>***</worker_hpc_cluster_id>
            <data_disks>
                  <encrypted>false</encrypted>
                  <size>40</size>
                  <category>cloud_efficiency</category>
            </data_disks>
            <ram_policy>KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****</ram_policy>
            <auto_renew>false</auto_renew>
            <instance_charge_type>PostPaid</instance_charge_type>
            <system_disk_category>cloud_efficiency</system_disk_category>
            <rds_instances>rds-xxx</rds_instances>
            <image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>
            <scaling_policy>release</scaling_policy>
            <vswitch_ids>vsw-2ze3ds0mdip0hdz8i****</vswitch_ids>
      </scaling_group>
      <kubernetes_config>
            <runtime_version>19.03.5</runtime_version>
            <cpu_policy>none</cpu_policy>
            <cms_enabled>true</cms_enabled>
            <overwrite_hostname>false</overwrite_hostname>
            <runtime>docker</runtime>
            <taints>
                  <effect>NoSca</effect>
                  <value>v-bb</value>
                  <key>k-bb</key>
            </taints>
            <user_data>***</user_data>
            <node_name_mode>nodeip</node_name_mode>
            <labels>
                  <value>v-aa</value>
                  <key>k-aa</key>
            </labels>
      </kubernetes_config>
      <auto_scaling>
            <health_check_type>***</health_check_type>
            <eip_internet_charge_type>***</eip_internet_charge_type>
            <enable>true</enable>
            <max_instances>10</max_instances>
            <min_instances>2</min_instances>
            <eip_bandwidth>5</eip_bandwidth>
            <type>cpu</type>
      </auto_scaling>
      <nodepool_info>
            <resource_group_id>***</resource_group_id>
            <created>2020-09-27T19:14:09.156823496+08:00</created>
            <name>default-nodepool</name>
            <region_id>cn-beijing</region_id>
            <is_default>true</is_default>
            <type>ess</type>
            <nodepool_id>np615c0e0966124216a0412e10afe0****</nodepool_id>
            <updated>2020-09-27T20:37:46+08:00</updated>
      </nodepool_info>
      <status>
            <serving_nodes>3</serving_nodes>
            <total_nodes>3</total_nodes>
            <state>active</state>
            <initial_nodes>0</initial_nodes>
            <offline_nodes>0</offline_nodes>
            <removing_nodes>0</removing_nodes>
            <failed_nodes>0</failed_nodes>
            <healthy_nodes>3</healthy_nodes>
      </status>
</nodepools>

JSON 格式

{
    "nodepools": [
        {
            "tee_config": {
                "tee_enable": "false"
            },
            "scaling_group": {
                "instance_types": "ecs.n4.large",
                "scaling_group_id": "***",
                "auto_renew_period": "0",
                "period": "0",
                "period_unit": "*",
                "security_group_id": "sg-2ze1iuk12m2sb4c4****",
                "multi_az_policy": "BALANCE",
                "system_disk_size": "120",
                "platform": "AliyunLinux",
                "tags": [
                    {
                        "value": "v-cc",
                        "key": "k-cc"
                    }
                ],
                "worker_hpc_cluster_id": "***",
                "data_disks": [
                    {
                        "encrypted": "false",
                        "size": "40",
                        "category": "cloud_efficiency"
                    }
                ],
                "ram_policy": "KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****",
                "auto_renew": "false",
                "instance_charge_type": "PostPaid",
                "system_disk_category": "cloud_efficiency",
                "rds_instances": "rds-xxx",
                "image_id": "aliyun_2_1903_x64_20G_alibase_20200529.vhd",
                "scaling_policy": "release",
                "vswitch_ids": "vsw-2ze3ds0mdip0hdz8i****"
            },
            "kubernetes_config": {
                "runtime_version": "19.03.5",
                "cpu_policy": "none",
                "cms_enabled": "true",
                "overwrite_hostname": "false",
                "runtime": "docker",
                "taints": [
                    {
                        "effect": "NoSca",
                        "value": "v-bb",
                        "key": "k-bb"
                    }
                ],
                "user_data": "***",
                "node_name_mode": "nodeip",
                "labels": [
                    {
                        "value": "v-aa",
                        "key": "k-aa"
                    }
                ]
            },
            "auto_scaling": {
                "health_check_type": "***",
                "eip_internet_charge_type": "***",
                "enable": "true",
                "max_instances": "10",
                "min_instances": "2",
                "eip_bandwidth": "5",
                "type": "cpu"
            },
            "nodepool_info": {
                "resource_group_id": "***",
                "created": "2020-09-27T19:14:09.156823496+08:00",
                "name": "default-nodepool",
                "region_id": "cn-beijing",
                "is_default": "true",
                "type": "ess",
                "nodepool_id": "np615c0e0966124216a0412e10afe0****",
                "updated": "2020-09-27T20:37:46+08:00"
            },
            "status": {
                "serving_nodes": "3",
                "total_nodes": "3",
                "state": "active",
                "initial_nodes": "0",
                "offline_nodes": "0",
                "removing_nodes": "0",
                "failed_nodes": "0",
                "healthy_nodes": "3"
            }
        }
    ]
}

错误码

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