All Products
Search
Document Center

Container Service for Kubernetes:DescribeClusterNodePoolDetail

Last Updated:Feb 29, 2024

You can call the DescribeClusterNodePoolDetail.html operation to query the details about a node pool in a cluster by node pool ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeClusterNodePoolDetailRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

GET /clusters/{ClusterId}/nodepools/{NodepoolId}

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster that you want to query.

c23421cfa74454bc8b37163fd19af****
NodepoolIdstringYes

The node pool ID.

np31da1b38983f4511b490fc62108a****

Response parameters

ParameterTypeDescriptionExample
object

The details about the node pool.

auto_scalingobject

The auto scaling configuration of the node pool.

eip_bandwidthlong

The maximum bandwidth of the elastic IP address (EIP).

5
eip_internet_charge_typestring

The metering method of the EIP. Valid values:

  • PayByBandwidth: pay-by-bandwidth.
  • PayByTraffic: pay-by-data-transfer.
PayByBandwidth
enableboolean

Indicates whether auto scaling is enabled. Valid values:

  • true: auto scaling is enabled.
  • false: auto scaling is disabled. If this parameter is set to false, other parameters in the auto_scaling section do not take effect.
true
is_bond_eipboolean

Indicates whether an EIP is associated with the node pool. Valid values:

  • true: An EIP is associated with the node pool.
  • false: No EIP is associated with the node pool.
true
max_instanceslong

The maximum number of Elastic Compute Service (ECS) instances that can be created in the node pool.

10
min_instanceslong

The minimum number of ECS instances that must be kept in the node pool.

1
typestring

The instance types that can be used for the auto scaling of the node pool. Valid values:

  • cpu: regular instance.
  • gpu: GPU-accelerated instance.
  • gpushare: shared GPU-accelerated instance.
  • spot: preemptible instance.
cpu
kubernetes_configobject

The configuration of the cluster where the node pool is deployed.

cms_enabledboolean

Indicates whether the CloudMonitor agent is installed on ECS nodes in the cluster. After the CloudMonitor agent is installed, you can view monitoring information about the ECS instances in the CloudMonitor console. Installation is recommended. Valid values:

  • true: The CloudMonitor agent is installed on ECS nodes.
  • false: The CloudMonitor agent is not installed on ECS nodes.
true
cpu_policystring

The CPU management policy of the nodes in the node pool. The following policies are supported if the Kubernetes version of the cluster is 1.12.6 or later.

  • static: allows pods with specific resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.
  • none: indicates that the default CPU affinity is used.
none
labelsarray

The labels of the nodes in the node pool. You can add labels to the nodes in the cluster. You must add labels based on the following rules:

  • Each label is a case-sensitive key-value pair. You can add up to 20 labels.
  • A key must be unique and cannot exceed 64 characters in length. A value can be empty and cannot exceed 128 characters in length. Keys and values cannot start with aliyun, acs:, https://, or http://. For more information, see Labels and Selectors.
tag

The label to be added to the ECS instances.

runtimestring

The name of the container runtime.

docker
runtime_versionstring

The version of the container runtime.

19.03.5
taintsarray

The taints of the nodes in the node pool. Taints are added to nodes to prevent pods from being scheduled to inappropriate nodes. However, tolerations allow pods to be scheduled to nodes with matching taints. For more information, see taint-and-toleration.

taint

The configurations of node taints.

user_datastring

The user data of the node pool. For more information, see Generate user data.

IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi
node_name_modestring

A custom node name consists of a prefix, an IP substring, and a suffix.

  • The prefix and suffix can contain multiple parts that are separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). A custom node name must start and end with a digit or lowercase letter.
  • The IP substring length specifies the number of digits to be truncated from the end of the node IP address. The IP substring length ranges from 5 to 12.

For example, if the node IP address is 192.168.0.55, the prefix is aliyun.com, the IP substring length is 5, and the suffix is test, the node name will be aliyun.com00055test.

customized,test.,5,.com
nodepool_infoobject

The configuration of the node pool.

createdstring

The time when the node pool was created.

2020-09-27T19:14:09.156823496+08:00
is_defaultboolean

Indicates whether the node pool is a default node pool. A Container Service for Kubernetes (ACK) cluster usually has only one default node pool. Valid values: true: The node pool is a default node pool. false: The node pool is not a default node pool.

true
namestring

The name of the node pool.

The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-).

default-nodepool
nodepool_idstring

The node pool ID.

np615c0e0966124216a0412e10afe0****
region_idstring

The region ID.

cn-beijing
resource_group_idstring

The ID of the resource group.

rg-acfmyvw3wjmb****
typestring

The type of node pool.

ess
updatedstring

The time when the node pool was last updated.

2020-09-27T20:37:46+08:00
scaling_groupobject

The configuration of the scaling group.

auto_renewboolean

Indicates whether auto-renewal is enabled for the nodes in the node pool. This parameter takes effect only when instance_charge_type is set to PrePaid. Valid values:

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
false
auto_renew_periodlong

The duration of the auto-renewal. This parameter takes effect and is required only when instance_charge_type is set to PrePaid.

If you specify PeriodUnit=Month, the valid values are 1, 2, 3, 6, and 12.

1
data_disksarray

The configurations of the data disks that are attached to the nodes in the node pool. The configurations include the disk type and disk size.

data_disk

Configurations of node data disks.

image_idstring

The ID of the custom image. You can call the DescribeKubernetesVersionMetadata operation to query the images supported by ACK.

aliyun_2_1903_x64_20G_alibase_20200529.vhd
instance_charge_typestring

The billing method of the nodes in the node pool. Valid values:

  • PrePaid: the subscription billing method.
  • PostPaid: the pay-as-you-go billing method.
PostPaid
instance_typesarray

A list of instance types. You can select multiple instance types. When the system needs to create a node, it starts from the first instance type until the node is created. The instance type that is used to create the node varies based on the actual instance stock.

string

The instance types of the nodes in the node pool.

ecs.n4.large
multi_az_policystring

The ECS instance scaling policy for a multi-zone scaling group. Valid values:

  • PRIORITY: the scaling group is scaled based on the VSwitchIds.N parameter. If an ECS instance cannot be created in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates the ECS instance in the zone where the vSwitch that has the next highest priority resides.

  • COST_OPTIMIZED: ECS instances are created based on the vCPU unit price in ascending order. Preemptible instances are preferably created when preemptible instance types are specified in the scaling configuration. You can set the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.

    **

    NoteThe COST_OPTIMIZED setting takes effect only when multiple instance types are specified or at least one instance type is specified for preemptible instances.

  • BALANCE: ECS instances are evenly distributed across multiple zones specified by the scaling group. If ECS instances become imbalanced among multiple zones due to insufficient inventory, you can call the RebalanceInstances operation of Auto Scaling to balance the instance distribution among zones. For more information, see RebalanceInstances .

Default value: PRIORITY.

BALANCE
on_demand_base_capacitylong

The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.

0
on_demand_percentage_above_base_capacitylong

The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by on_demand_base_capacity. Valid values: 0 to 100.

20
spot_instance_poolslong

The number of instance types that are available for creating preemptible instances. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.

5
spot_instance_remedyboolean

Indicates whether preemptible instances are supplemented when the number of preemptible instances drops below the specified minimum number. If this parameter is set to true, when the scaling group receives a system message that a preemptible instance is to be reclaimed, the scaling group attempts to create a new instance to replace this instance. Valid values: Valid values:

  • true: Supplementation of preemptible instances is enabled.
  • false: Supplementation of preemptible instances is disabled.
false
compensate_with_on_demandboolean

Indicates whether pay-as-you-go instances are automatically created to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as cost or insufficient inventory. This parameter takes effect when multi_az_policy is set to COST_OPTIMIZED. Valid values:

  • true: Pay-as-you-go instances are automatically created to meet the required number of ECS instances if preemptible instances cannot be created.
  • false: Pay-as-you-go instances are not automatically created to meet the required number of ECS instances if preemptible instances cannot be created.
true
periodlong

The subscription duration of worker nodes. This parameter takes effect and is required only when instance_charge_type is set to PrePaid.

If PeriodUnit=Month is specified, the valid values are 1, 2, 3, 6, 12, 24, 36, 48, and 60.

0
period_unitstring

The billing cycle of the nodes. This parameter is required if instance_charge_type is set to PrePaid.

Valid value: Month.

Month
platformstring

The release version of the operating system. Valid values:

  • CentOS
  • AliyunLinux
  • Windows
  • WindowsCore
AliyunLinux
ram_policystring

The name of the worker Resource Access Management (RAM) role. The RAM role is assigned to the worker nodes of the cluster to allow the worker nodes to manage ECS instances.

KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****
spot_strategystring

The type of preemptible instance. Valid values:

  • NoSpot: a non-preemptible instance.
  • SpotWithPriceLimit: a preemptible instance that is configured with the highest bid price.
  • SpotAsPriceGo: a preemptible instance for which the system automatically bids based on the current market price.

For more information, see Preemptible instances.

NoSpot
spot_price_limitobject []

The bid configurations of preemptible instances.

instance_typestring

The instance type of preemptible instances.

ecs.c6.large
price_limitstring

The price limit of a preemptible instance.

Unit: USD/hour.

0.39
rds_instancesarray

After you specify the list of RDS instances, the ECS instances in the cluster are automatically added to the whitelist of the RDS instances.

string

The ApsaraDB RDS instance.

rm-xxx
scaling_group_idstring

The ID of the scaling group.

asg-2zeieod8giqmov7z****
scaling_policystring

The scaling mode of the scaling group. Valid values:

  • release: the standard mode. ECS instances are created and released based on resource usage.
  • recycle: the swift mode. ECS instances are created, stopped, or started during scaling events. This reduces the time required for the next scale-out event. When the instance is stopped, you are charged only for the storage service. This does not apply to ECS instances that are attached with local disks.
release
security_group_idstring

The ID of the security group to which the node pool is added. If the node pool is added to multiple security groups, the first ID in the value of security_group_ids is returned.

sg-2ze60ockeekspl3d****
security_group_idsarray

The IDs of the security groups to which the node pool is added.

string

The IDs of the security groups to which the node pool is added.

sg-2ze60ockeekspl3d****
system_disk_categorystring

The type of system disk. Valid values:

  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD.
cloud_efficiency
system_disk_sizelong

The system disk size of a node. Unit: GiB.

Valid values: 20 to 500.

120
system_disk_performance_levelstring

The performance level (PL) of the system disk that you want to use for the node. This parameter takes effect only for enhanced SSDs (ESSDs).

PL1
tagsarray

The labels that you want to add to the ECS instances.

A key must be unique and cannot exceed 128 characters in length. Neither keys nor values can start with aliyun or acs:. Neither keys nor values can contain https:// or http://.

tag

The labels that you want to add to nodes.

vswitch_idsarray

The IDs of vSwitches. You can specify 1 to 20 vSwitches.

Note We recommend that you select vSwitches in different zones to ensure high availability.
string

The vSwitch ID.

vsw-2ze3ds0mdip0hdz8i****
login_passwordstring

The password for SSH logon. You must set this parameter or the key_pair parameter. The password must be 8 to 30 characters in length, and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

For security purposes, the returned password is encrypted.

********
key_pairstring

The name of the key pair. You must set this parameter or the login_password parameter. You must set key_pair if the node pool is a managed node pool.

pro-nodepool
internet_charge_typestring

The billing method of the public IP address of the node.

PayByBandwidth
internet_max_bandwidth_outlong

The maximum outbound bandwidth of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.

10
deploymentset_idstring

The ID of the deployment set to which the ECS instances in the node pool belong.

ds-bp1d19mmbsv3jf6xxxxx
desired_sizelong

The expected number of nodes in the node pool.

2
private_pool_optionsobject

The configuration of the private node pool.

idstring

The ID of the private node pool.

eap-bp67acfmxazb4****
match_criteriastring

The type of private node pool. This parameter specifies the type of private node pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:

  • Open: open private pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.
  • Target: specific private pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be launched.
  • None: no private node pool is used. The resources of private node pools are not used to launch the instances.
Open
statusobject

The status details about the node pool.

failed_nodeslong

The number of failed nodes.

0
healthy_nodeslong

The number of healthy nodes.

3
initial_nodeslong

The number of nodes that are being created.

0
offline_nodeslong

The number of offline nodes.

0
removing_nodeslong

The number of nodes that are being removed.

0
serving_nodeslong

The number of running nodes.

3
statestring

The status of the node pool. Valid values:

  • active: The node pool is active.
  • scaling: The node pool is being scaled.
  • removing: Nodes are being removed from the node pool.
  • deleting: The node pool is being deleted.
  • updating: The node pool is being updated.
active
total_nodeslong

The total number of nodes in the node pool.

3
tee_configobject

The configuration of confidential computing.

tee_enableboolean

Indicates whether confidential computing is enabled. Valid values:

  • true: Confidential computing is enabled.
  • false: Confidential computing is disabled.
false
managementobject

The configuration of the managed node pool feature.

enableboolean

Indicates whether the managed node pool feature is enabled. Valid values:

  • true: The managed node pool feature is enabled.
  • false: The managed node pool feature is disabled. Other parameters in this section take effect only when enable=true is specified.
true
auto_repairboolean

Indicates whether auto repair is enabled. This parameter takes effect only when enable=true is specified. Valid values:

  • true: Auto repair is enabled.
  • false: Auto repair is disabled.
true
upgrade_configobject

The configuration of auto update. The configuration takes effect only when enable=true is specified.

auto_upgradeboolean

Indicates whether auto update is enabled. Valid values:

  • true: Auto update is enabled.
  • false: Auto update is disabled.
true
surgelong

The number of additional nodes.

5
surge_percentagelong

The percentage of additional nodes to the nodes in the node pool. You must set this parameter or surge.

50
max_unavailablelong

The maximum number of nodes that can be in the Unavailable state. Valid values: 1 to 1000.

Default value: 1.

1
interconnect_configobject

The network configuration of the edge node pool. This parameter takes effect only for edge node pools.

cen_idstring

The ID of the Cloud Enterprise Network (CEN) instance that is associated with the enhanced edge node pool.

cen-ey9k9nfhz0f*******
ccn_idstring

The ID of the Cloud Connect Network (CCN) instance that is associated with the enhanced edge node pool.

ccn-qm5i0i0q9yi*******
ccn_region_idstring

The region to which the CCN instance that is associated with the enhanced edge node pool belongs.

cn-shanghai
bandwidthlong

The bandwidth of the enhanced edge node pool. Unit: Mbit/s.

10
improved_periodstring

The subscription duration of the enhanced edge node pool. The duration is measured in months.

1
interconnect_modestring

The network type of the edge node pool. Valid values: basic and enhanced. This parameter takes effect only for edge node pools.

improved
max_nodeslong

The maximum number of nodes that are supported by the edge node pool. The value of this parameter must be equal to or greater than 0. A value of 0 indicates that the number of nodes in the node pool is limited only by the quota of nodes in the cluster. In most cases, this parameter is set to a value larger than 0 for edge node pools. This parameter is set to 0 for node pools whose types are ess or default edge node pools.

10

Examples

Sample success responses

JSONformat

{
  "auto_scaling": {
    "eip_bandwidth": 5,
    "eip_internet_charge_type": "PayByBandwidth",
    "enable": true,
    "is_bond_eip": true,
    "max_instances": 10,
    "min_instances": 1,
    "type": "cpu"
  },
  "kubernetes_config": {
    "cms_enabled": true,
    "cpu_policy": "none",
    "labels": [
      {
        "key": "env",
        "value": "prod"
      }
    ],
    "runtime": "docker",
    "runtime_version": "19.03.5",
    "taints": [
      {
        "key": "key",
        "value": "value",
        "effect": "NoSchedule"
      }
    ],
    "user_data": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi",
    "node_name_mode": "customized,test.,5,.com"
  },
  "nodepool_info": {
    "created": "2020-09-27T19:14:09.156823496+08:00",
    "is_default": true,
    "name": "default-nodepool",
    "nodepool_id": "np615c0e0966124216a0412e10afe0****",
    "region_id": "cn-beijing",
    "resource_group_id": "rg-acfmyvw3wjmb****",
    "type": "ess",
    "updated": "2020-09-27T20:37:46+08:00"
  },
  "scaling_group": {
    "auto_renew": false,
    "auto_renew_period": 1,
    "data_disks": [
      {
        "category": "cloud_ssd",
        "size": 40,
        "encrypted": "true",
        "kms_key_id": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "auto_snapshot_policy_id": "sp-2zej1nogjvovnz4z****",
        "performance_level": "PL1",
        "provisioned_iops": 1000,
        "bursting_enabled": true,
        "auto_format": true,
        "file_system": "ext4",
        "mount_target": "/mnt/path1",
        "disk_name": "DataDiskName",
        "device": "/dev/xvdb",
        "snapshot_id": "s-280s7****"
      }
    ],
    "image_id": "aliyun_2_1903_x64_20G_alibase_20200529.vhd",
    "instance_charge_type": "PostPaid",
    "instance_types": [
      "ecs.n4.large"
    ],
    "multi_az_policy": "BALANCE",
    "on_demand_base_capacity": 0,
    "on_demand_percentage_above_base_capacity": 20,
    "spot_instance_pools": 5,
    "spot_instance_remedy": false,
    "compensate_with_on_demand": true,
    "period": 0,
    "period_unit": "Month",
    "platform": "AliyunLinux",
    "ram_policy": "KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****",
    "spot_strategy": "NoSpot",
    "spot_price_limit": [
      {
        "instance_type": "ecs.c6.large",
        "price_limit": "0.39"
      }
    ],
    "rds_instances": [
      "rm-xxx"
    ],
    "scaling_group_id": "asg-2zeieod8giqmov7z****",
    "scaling_policy": "release",
    "security_group_id": "sg-2ze60ockeekspl3d****",
    "security_group_ids": [
      "sg-2ze60ockeekspl3d****"
    ],
    "system_disk_category": "cloud_efficiency",
    "system_disk_size": 120,
    "system_disk_performance_level": "PL1",
    "tags": [
      {
        "key": "env",
        "value": "prod"
      }
    ],
    "vswitch_ids": [
      "vsw-2ze3ds0mdip0hdz8i****"
    ],
    "login_password": "********",
    "key_pair": "pro-nodepool",
    "internet_charge_type": "PayByBandwidth",
    "internet_max_bandwidth_out": 10,
    "deploymentset_id": "ds-bp1d19mmbsv3jf6xxxxx",
    "desired_size": 2,
    "private_pool_options": {
      "id": "eap-bp67acfmxazb4****",
      "match_criteria": "Open"
    }
  },
  "status": {
    "failed_nodes": 0,
    "healthy_nodes": 3,
    "initial_nodes": 0,
    "offline_nodes": 0,
    "removing_nodes": 0,
    "serving_nodes": 3,
    "state": "active",
    "total_nodes": 3
  },
  "tee_config": {
    "tee_enable": false
  },
  "management": {
    "enable": true,
    "auto_repair": true,
    "upgrade_config": {
      "auto_upgrade": true,
      "surge": 5,
      "surge_percentage": 50,
      "max_unavailable": 1
    },
    "auto_repair_policy": {
      "restart_node": true
    },
    "auto_vul_fix": true,
    "auto_vul_fix_policy": {
      "restart_node": true,
      "vul_level": "asap,nntf"
    },
    "auto_upgrade": true,
    "auto_upgrade_policy": {
      "auto_upgrade_kubelet": true
    }
  },
  "interconnect_config": {
    "cen_id": "cen-ey9k9nfhz0f*******",
    "ccn_id": "ccn-qm5i0i0q9yi*******",
    "ccn_region_id": "cn-shanghai",
    "bandwidth": 10,
    "improved_period": "1"
  },
  "interconnect_mode": "improved",
  "max_nodes": 10,
  "node_config": {
    "kubelet_configuration": {
      "registryPullQPS": 5,
      "registryBurst": 10,
      "eventRecordQPS": 5,
      "eventBurst": 10,
      "kubeAPIQPS": 5,
      "kubeAPIBurst": 10,
      "serializeImagePulls": true,
      "cpuManagerPolicy": "none",
      "evictionHard": {
        "test": "test",
        "test2": 1
      },
      "evictionSoft": {
        "test": "test",
        "test2": 1
      },
      "evictionSoftGracePeriod": {
        "test": "test",
        "test2": 1
      },
      "systemReserved": {
        "test": "test",
        "test2": 1
      },
      "kubeReserved": {
        "test": "test",
        "test2": 1
      },
      "readOnlyPort": 0,
      "maxPods": 110,
      "containerLogMaxSize": "10Mi",
      "containerLogMaxFiles": 5,
      "featureGates": {
        "test": "test",
        "test2": 1
      },
      "allowedUnsafeSysctls": [
        "net.core.somaxconn"
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-12-13The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-10-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-23The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2020-09-23The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2020-09-23The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.