All Products
Search

This Product

    Container Service for Kubernetes:DescribeClusterNodePoolDetail

    Document Center

    Container Service for Kubernetes:DescribeClusterNodePoolDetail

    Last Updated:Jun 25, 2026

    Queries the configuration of a specified node pool in a cluster by node pool ID.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cs:DescribeClusterNodePoolDetail

    get

    *Cluster

    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

    		 None None

    Request syntax

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

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    Yes

    The cluster ID.

    c23421cfa74454bc8b37163fd19af****
    NodepoolId

    string

    Yes

    The node pool ID.

    np31da1b38983f4511b490fc62108a****

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    The node pool details.

    nodepool_info

    object

    The node pool configuration.

    nodepool_id

    string

    The node pool ID.

    np615c0e0966124216a0412e10afe0****
    name

    string

    The node pool name.

    default-nodepool
    type

    string

    The node pool type. Valid values:

    • ess: standard node pool (includes managed and automatic elastic scaling features).

    • edge: edge node pool.

    • lingjun: Lingjun node pool.

    ess
    is_default

    boolean

    Indicates whether this is the default node pool. Typically, a cluster has only one default node pool. Valid values:

    • true: This is the default node pool.

    • false: This is not the default node pool.

    true
    resource_group_id

    string

    The resource group ID.

    rg-acfmyvw3wjmb****
    region_id

    string

    The region ID.

    cn-beijing
    created

    string

    The time when the node pool was created.

    2025-04-10T14:25:37.285530433+08:00
    updated

    string

    The time when the node pool was last updated.

    2025-04-15T15:39:45.41+08:00
    status

    object

    The node pool status.

    state

    string

    The node pool status. Valid values:

    • active: The node pool is active.

    • scaling: The node pool is scaling.

    • removing: Nodes are being removed.

    • deleting: The node pool is being deleted.

    • updating: The node pool is being updated.

    active
    healthy_nodes

    integer

    The number of healthy nodes.

    3
    initial_nodes

    integer

    The number of nodes that are being created.

    0
    failed_nodes

    integer

    The number of failed nodes.

    0
    offline_nodes

    integer

    The number of offline nodes.

    0
    removing_nodes

    integer

    The number of nodes that are being removed.

    0
    serving_nodes

    integer

    The number of serving nodes.

    3
    total_nodes

    integer

    The total number of nodes in the node pool.

    3
    conditions

    array<object>

    The current conditions of the node pool, representing status information across different dimensions.

    object

    A single status condition.

    type

    string

    The type.

    ImageUpgradeReady
    status

    string

    The status.

    True
    reason

    string

    The reason.

    UpgradeDisabled
    message

    string

    The detailed information.

    AutoUpgradeDisabled
    last_transition_time

    string

    The time of the last status transition.

    20**-**-30T10:39:00+08:00
    auto_scaling

    object

    The auto scaling configuration of the node pool.

    enable

    boolean

    Specifies whether to enable auto scaling. Valid values:

    • true: Enables the node pool elastic scaling feature. When the cluster capacity planning cannot meet application Pod scheduling requirements, ACK automatically scales node resources based on the configured minimum and maximum instance counts. Clusters of version 1.24 and later use instant node elasticity by default. Clusters of versions earlier than 1.24 use node auto scaling by default. For more information, see Node scaling.

    • false: Disables auto scaling. ACK adjusts the number of nodes in the node pool based on the configured desired node count, maintaining the node count at the desired number.

    When this parameter is set to false, other configuration parameters in auto_scaling do not take effect.

    true
    type

    string

    The auto scaling type, categorized by instance type. Valid values:

    • cpu: regular instance type.

    • gpu: GPU instance type.

    • gpushare: GPU sharing type.

    • spot: spot instance type.

    cpu
    max_instances

    integer

    The maximum number of instances that can be scaled in the node pool, excluding your existing instances.

    10
    min_instances

    integer

    The minimum number of instances that can be scaled in the node pool, excluding your existing instances.

    1
    eip_internet_charge_type

    string

    The billing method for EIPs. Valid values:

    • PayByBandwidth: pay-by-bandwidth.

    • PayByTraffic: pay-by-traffic.

    PayByBandwidth
    is_bond_eip

    boolean

    Specifies whether to associate an EIP. Valid values:

    • true: Associate an EIP.

    • false: Do not associate an EIP.

    true
    eip_bandwidth

    integer

    The peak bandwidth of the EIP.

    Valid values: [1,100]. Unit: Mbit/s.

    5
    management

    object

    The managed node pool configuration.

    enable

    boolean

    Specifies whether to enable the managed node pool. Valid values:

    • true: Enable the managed node pool.

    • false: Disable the managed node pool. Other related configurations take effect only when enable=true.

    true
    auto_repair

    boolean

    Specifies whether to enable auto repair. This parameter takes effect only when enable=true. Valid values:

    • true: Enable auto repair.

    • false: Disable auto repair.

    true
    auto_repair_policy

    object

    The auto repair policy for nodes.

    restart_node

    boolean

    Specifies whether to allow node restarts. This parameter takes effect only when auto_repair=true.

    • true: Allow node restarts.

    • false: Do not allow node restarts.

    true
    approval_required

    boolean

    Specifies whether manual approval is required for node repair.

    false
    auto_repair_policy_id

    string

    The auto repair policy ID.

    r-xxxxxxxxxx
    auto_vul_fix

    boolean

    Specifies whether to enable automatic CVE fixing. This parameter takes effect only when enable=true. Valid values:

    • true: Enable automatic CVE fixing.

    • false: Disable automatic CVE fixing.

    true
    auto_vul_fix_policy

    object

    The automatic CVE fixing policy.

    restart_node

    boolean

    Specifies whether to allow node restarts. This parameter takes effect only when auto_vul_fix=true. Valid values:

    • true: Allow node restarts.

    • false: Do not allow node restarts.

    true
    vul_level

    string

    The vulnerability levels that are allowed for automatic fixes, separated by commas.

    • asap: high

    • later: medium

    • nntf: low.

    asap,nntf
    exclude_packages

    string

    The packages that should be excluded during vulnerability fixes.

    kernel
    auto_upgrade

    boolean

    Specifies whether to enable automatic node upgrades. This parameter takes effect only when enable=true. Valid values:

    • true: Enable automatic upgrades.

    • false: Disable automatic upgrades.

    true
    auto_upgrade_policy

    object

    The automatic upgrade policy.

    auto_upgrade_kubelet

    boolean

    Specifies whether to allow automatic kubelet upgrades. This parameter takes effect only when auto_upgrade=true. Valid values:

    • true: Allow automatic kubelet upgrades.

    • false: Do not allow automatic kubelet upgrades.

    true
    upgrade_config

    object

    The automatic upgrade configuration. This parameter takes effect only when enable=true.

    auto_upgrade

    boolean

    Specifies whether to enable automatic upgrades. Valid values:

    • true: Enable automatic upgrades.

    • false: Disable automatic upgrades.

    true
    surge

    integer

    The number of extra nodes. You can set this parameter or surge_percentage, but not both.

    5
    surge_percentage

    integer

    The percentage of extra nodes. You can set this parameter or surge, but not both.

    Number of extra nodes = Extra node percentage × Number of nodes. For example, if the extra node percentage is set to 50% and there are 6 existing nodes, the number of extra nodes = 50% × 6 = 3.

    50
    max_unavailable

    integer

    The maximum number of unavailable nodes. Valid values: [1,1000].

    Default value: 1.

    1
    auto_fault_diagnosis

    boolean

    scaling_group

    object

    The scaling group configuration of the node pool.

    scaling_group_id

    string

    The scaling group ID.

    asg-2zeieod8giqmov7z****
    vswitch_ids

    array

    The list of vSwitch IDs.

    string

    The vSwitch ID.

    vsw-2ze3ds0mdip0hdz8i****
    instance_types

    array

    The list of node instance types.

    string

    The node instance type.

    ecs.n4.large
    instance_charge_type

    string

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

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    PostPaid
    period

    integer

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

    • When period_unit=Week, valid values of period: {1, 2, 3, 4}.

    • When period_unit=Month, valid values of period: {1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60}.

    0
    period_unit

    string

    The billing epoch for nodes. This parameter must be specified when instance_charge_type is set to PrePaid. Valid values:

    • Month: billed on a monthly basis.

    • Week: billed on a weekly basis.

    Month
    auto_renew

    boolean

    Specifies whether to enable auto-renewal for nodes. This parameter takes effect only when instance_charge_type is set to PrePaid. Valid values:

    • true: Enable auto-renewal.

    • false: Disable auto-renewal.

    false
    auto_renew_period

    integer

    The auto-renewal period. Valid values:

    • When PeriodUnit=Week: 1, 2, 3.

    • When PeriodUnit=Month: 1, 2, 3, 6, 12, 24, 36, 48, 60.

    1
    spot_strategy

    string

    The spot instance type. Valid values:

    • NoSpot: non-spot instance.

    • SpotWithPriceLimit: spot instance with a price limit.

    • SpotAsPriceGo: system automatically bids at the current market price.

    For more information, see Spot instances.

    NoSpot
    spot_price_limit

    array<object>

    The China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site China site.

    object

    The spot instance marketplace price range configuration. You can set different price limits for different instance types.

    instance_type

    string

    The spot instance type.

    ecs.c6.large
    price_limit

    string

    The market price of a single instance.

    Unit: USD/hour..

    0.39
    image_type

    string

    The operating system image type. Valid values:

    • AliyunLinux: Alinux2 image.

    • AliyunLinuxSecurity: Alinux2 UEFI image.

    • AliyunLinux3: Alinux3 image.

    • AliyunLinux3Arm64: Alinux3 ARM image.

    • AliyunLinux3Security: Alinux3 UEFI image.

    • CentOS: CentOS image.

    • Windows: Windows image.

    • WindowsCore: WindowsCore image.

    • ContainerOS: container-optimized image.

    • AliyunLinux3ContainerOptimized: Alinux3 container-optimized image.

    AliyunLinux3
    image_id

    string

    The custom image ID.

    aliyun_3_x64_20G_alibase_20241218.vhd
    system_disk_category

    string

    The system cloud disk type for nodes. Valid values:

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: ESSD.

    • cloud_auto: ESSD AutoPL cloud disk.

    • cloud_essd_entry: ESSD Entry cloud disk.

    cloud_efficiency
    system_disk_categories

    array

    The multi-disk types for the system cloud disk. When a higher-priority disk type is unavailable, the system automatically attempts the next-priority disk type to create the system cloud disk.

    string

    The system cloud disk type for nodes. Valid values:

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: ESSD.

    • cloud_auto: ESSD AutoPL cloud disk.

    • cloud_essd_entry: ESSD Entry cloud disk.

    cloud_essd
    system_disk_size

    integer

    The system cloud disk size for nodes. Unit: GiB.

    Valid values: [20,2048].

    120
    system_disk_performance_level

    string

    The performance level of the node system cloud disk. This parameter takes effect only for ESSD cloud disks. The performance level is related to the disk size. For more information, see ESSDs. Valid values:

    • PL0: moderate maximum concurrent I/O performance with relatively stable read/write latency.

    • PL1: moderate maximum concurrent I/O performance with relatively stable read/write latency.

    • PL2: high maximum concurrent I/O performance with stable read/write latency.

    • PL3: ultra-high maximum concurrent I/O performance with extremely stable read/write latency.

    PL1
    system_disk_encrypted

    boolean

    Specifies whether to encrypt the system cloud disk. Valid values:

    • true: Encrypt the system cloud disk.

    • false: Do not encrypt the system cloud disk.

    false
    system_disk_kms_key_id

    string

    The KMS key ID used for the system cloud disk.

    0e478b7a-4262-4802-b8cb-00d3fb40****
    system_disk_encrypt_algorithm

    string

    The encryption algorithm used for the system cloud disk. Valid values: aes-256.

    aes-256
    system_disk_bursting_enabled

    boolean

    Specifies whether to enable burst (performance burst) for the node system cloud disk. Valid values:

    • true: Enable burst. When enabled, the cloud disk temporarily improves performance during sudden data read/write pressure from fluctuating workloads until the workload recovers to a steady state.

    • false: Disable burst.

    This parameter is supported only when system_disk_category is set to cloud_auto. For more information, see ESSD AutoPL cloud disks.

    true
    system_disk_provisioned_iops

    integer

    The provisioned read/write IOPS for the node system cloud disk.

    Valid values: 0~min{50,000, 1000*capacity-baseline performance}. Baseline performance=min{1,800+50*capacity, 50000}.

    This parameter is supported only when system_disk_category is set to cloud_auto. For more information, see ESSD AutoPL cloud disks.

    1000
    data_disks

    array

    The data cloud disk type, size, and other configurations.

    data_disk

    The data cloud disk configuration for nodes.

    security_group_ids

    array

    The list of security group IDs for the node pool.

    string

    The security group ID for the node pool.

    sg-2ze60ockeekspl3d****
    key_pair

    string

    The key pair name. You can set this parameter or login_password. When the node pool is a managed node pool, only key_pair is supported.

    pro-nodepool
    login_password

    string

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

    For security purposes, the password is encrypted in query results.

    ********
    login_as_non_root

    boolean

    Indicates whether the ECS instance uses a non-root user for logon. Valid values:

    • true: Log on as a non-root user (ecs-user).

    • false: Log on as the root user.

    true
    cis_enabled deprecated

    boolean

    [This field is deprecated] Use the security_hardening_os parameter as an override.

    false
    soc_enabled

    boolean

    Specifies whether to enable MLPS 2.0 security hardening. This parameter is available only when the system image is Alibaba Cloud Linux 2 or Alibaba Cloud Linux 3. Alibaba Cloud provides classified protection compliance baseline check standards and scanning programs for Alibaba Cloud Linux 2 and Alibaba Cloud Linux 3 MLPS 2.0 Level 3 images.

    false
    security_hardening_os

    boolean

    Specifies whether to enable Alibaba Cloud OS security hardening. Valid values:

    • true: Enable Alibaba Cloud OS security hardening.

    • false: Disable Alibaba Cloud OS security hardening.

    Default value: false.

    false
    internet_charge_type

    string

    The billing method for the public IP address of nodes. Valid values:

    • PayByBandwidth: pay-by-bandwidth.

    • PayByTraffic: pay-by-traffic.

    PayByBandwidth
    internet_max_bandwidth_out

    integer

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

    10
    tags

    array

    The ECS instance labels.

    tag

    The node label.

    desired_size

    integer

    The desired number of nodes in the node pool.

    2
    multi_az_policy

    string

    The multi-zone scaling policy for ECS instances in the scaling group. Valid values:

    • PRIORITY: Scales based on the vSwitches (VSwitchIds.N) that you define. When ECS instances cannot be created in the zone of a higher-priority vSwitch, the system automatically uses the next-priority vSwitch to create ECS instances.

    • COST_OPTIMIZED: Attempts to create instances in ascending order of vCPU unit price. When the scaling configuration specifies multiple instance types with spot billing method, spot instances are created first. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when spot instances cannot be created due to insufficient inventory.

      Note

      COST_OPTIMIZED takes effect only when multiple instance types are specified in the scaling configuration or spot instances are selected.

    • BALANCE: Evenly distributes ECS instances across the multiple active zones specified in the scaling group. If zones become unbalanced due to insufficient inventory, you can call the RebalanceInstances operation to rebalance resources. For more information, see RebalanceInstances.

    Default value: PRIORITY.

    BALANCE
    scaling_policy

    string

    The scaling group pattern. Valid values:

    • release: standard pattern. Scales by creating and releasing ECS instances based on resource usage.

    • recycle: swift pattern. Scales by creating, stopping, and starting instances to improve subsequent scaling speed. Stopped instances are not charged for compute resources, only for storage. This does not apply to local disk instance types.

    release
    on_demand_base_capacity

    integer

    The minimum number of pay-as-you-go instances required in the scaling group. Valid values: [0,1000]. When the number of pay-as-you-go instances is less than this value, pay-as-you-go instances are created first.

    0
    on_demand_percentage_above_base_capacity

    integer

    The percentage of pay-as-you-go instances among the instances that exceed the minimum pay-as-you-go instance count (on_demand_base_capacity). Valid values: [0,100].

    20
    spot_instance_pools

    integer

    The number of active instance types. The scaling group creates spot instances across multiple types with the lowest cost in a balanced manner. Valid values: [1,10].

    5
    spot_instance_remedy

    boolean

    Specifies whether to enable spot instance supplementation. When enabled, the scaling group attempts to create new instances to replace spot instances that are about to be revoked. Valid values:

    • true: Enable spot instance supplementation.

    • false: Disable spot instance supplementation.

    false
    compensate_with_on_demand

    boolean

    Specifies whether to allow automatic creation of pay-as-you-go instances to meet the required number of ECS instances when spot instances cannot be created due to cost or inventory reasons. This parameter takes effect only when multi_az_policy is set to COST_OPTIMIZED. Valid values:

    • true: Allow automatic creation of pay-as-you-go instances.

    • false: Do not allow automatic creation of pay-as-you-go instances.

    true
    deploymentset_id

    string

    The deployment set ID.

    ds-bp1d19mmbsv3jf6xxxxx
    rds_instances

    array

    The list of RDS instances. If specified, the ECS instances in the cluster node are automatically added to the RDS access whitelist.

    string

    The RDS instance.

    rm-xxx
    private_pool_options

    object

    The private pool configuration.

    id

    string

    The private pool ID.

    eap-bp67acfmxazb4****
    match_criteria

    string

    The private pool type, which specifies the capacity option for instance launch. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instance launch. Valid values:

    • Open: open mode. Automatically matches open private pool capacity. If no matching private pool capacity is available, public pool resources are used.

    • Target: targeted mode. Uses the specified private pool capacity to launch instances. If the specified private pool capacity is unavailable, the instance fails to launch.

    • None: none mode. Private pool capacity is not used for instance launch.

    Open
    security_group_id

    string

    The security group ID of the node pool. When the node pool is attached to multiple security groups, this is the first value in security_group_ids.

    sg-2ze60ockeekspl3d****
    platform

    string

    The operating system distribution. Valid values:

    • CentOS

    • AliyunLinux

    • Windows

    • WindowsCore

    AliyunLinux
    ram_policy

    string

    [This field is deprecated] Use ram_role_name as an override.

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

    array

    The instance property configurations.

    instance_patterns

    The instance property.

    ram_role_name

    string

    The Worker RAM role name.

    KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****
    instance_metadata_options InstanceMetadataOptions

    The metadata access configuration for ECS instances.

    resource_pool_options

    object

    The resource pool and resource pool policy used when creating instances.

    private_pool_ids

    array

    The list of private pool IDs.

    string

    The private pool ID.

    eap-bp1c1fohub5jccwi****
    strategy

    string

    The resource pool policy used for instance creation. Valid values: PrivatePoolFirst: private pool first. PrivatePoolOnly: private pool only. None: no resource pool policy.

    PrivatePoolFirst
    system_disk_snapshot_policy_id

    string

    The snapshot policy for the system cloud disk.

    sp-bp11g8z59rawcud9****
    disk_init

    array

    The block device initialization configuration.

    DiskInit

    The DiskInit configuration.

    node_config

    object

    The node configuration.

    kubelet_configuration kubelet_config

    The Kubelet parameter settings.

    node_os_config

    object

    The node operating system configuration.

    hugepage

    Hugepage

    The hugepage configuration.

    kubernetes_config

    object

    The cluster-related configuration.

    labels

    array

    The node labels.

    tag

    The ECS label.

    taints

    array

    The node taint information. Taints and tolerations work together to prevent Pods from being allocated to inappropriate nodes. For more information, see taint-and-toleration.

    taint

    The node taint configuration.

    runtime

    string

    The container runtime name. ACK supports the following three container runtimes:

    • containerd: recommended. Supports all cluster versions.

    • Sandboxed-Container.runv: sandboxed container runtime that provides higher isolation. Supports clusters of version 1.31 and earlier. No longer under maintenance.

    • docker: no longer under maintenance. Supports clusters of version 1.22 and earlier.

    containerd
    runtime_version

    string

    The container runtime version.

    1.6.38
    cpu_policy

    string

    The CPU management policy for nodes. The following two policies are supported for clusters of version 1.12.6 and later:

    • static: Allows Pods with certain resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.

    • none: Uses the existing default CPU affinity scheme.

    none
    user_data

    string

    The custom data for the node pool. This is a script that runs after node initialization. For more details, see Generate instance user data.

    IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi
    unschedulable

    boolean

    Indicates whether the scaled-out nodes are unschedulable for scheduling. Valid values:

    • true: Unschedulable.

    • false: Schedulable.

    true
    cms_enabled

    boolean

    Specifies whether to install the CloudMonitor agent on ECS nodes. After installation, you can view monitoring information for the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. Valid values:

    • true: Install the CloudMonitor agent on ECS nodes.

    • false: Do not install the CloudMonitor agent on ECS nodes.

    true
    node_name_mode

    string

    The custom node name.

    The node name consists of three parts: prefix + node IP address substring + suffix:

    • The prefix and suffix can each consist of one or more parts separated by ".". Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or digit.

    • The IP address segment length specifies the number of digits taken from the end of the node IP address. Valid values: 5 to 12.

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

    aliyun.com192.XX.YY.55test
    pre_user_data

    string

    The pre-custom data for the node pool. This is a script that runs before node initialization. For more details, see Generate instance user data.

    dGhpcyBpcyBhIGV4YW1wbGU

    tee_config

    object

    The encrypted computing cluster configuration.

    tee_enable

    boolean

    Specifies whether to enable the encrypted computing cluster. Valid values:

    • true: Enable.

    • false: Disable.

    false
    interconnect_config

    object

    [This field is deprecated]

    The network configuration for edge node pools. This value is meaningful only for node pools of the edge type.

    cen_id

    string

    [This field is deprecated]

    The Cloud Enterprise Network (CEN) instance ID attached to the enhanced edge node pool.

    cen-ey9k9nfhz0f*******
    ccn_id

    string

    [This field is deprecated]

    The Cloud Connect Network (CCN) instance ID attached to the enhanced edge node pool.

    ccn-qm5i0i0q9yi*******
    ccn_region_id

    string

    [This field

    cn-shanghai
    bandwidth

    integer

    【该字段已废弃】

    边缘增强型节点池的网络带宽，单位为 Mbps。

    10
    improved_period

    string

    【该字段已废弃】

    边缘增强型节点池的购买时长，单位为月。

    1
    max_nodes

    integer

    【该字段已废弃】

    边缘节点池允许容纳的最大节点数量。

    10
    interconnect_mode

    string

    边缘节点池的网络类型，该参数仅对type为edge类型的节点池生效，取值范围：

    • basic：公网。节点池内的节点通过公网与云端节点进行交互，节点池内应用不能直接访问云端 VPC 内网。

    • private：专用网络。节点池内的节点通过专线、VPN 或 CEN 等方式实现云上与云下网络打通，拥有更高的云边通信质量，提供更有效的安全保障。

    basic
    host_network

    boolean

    Pod 网络模式是否采用主机网络模式。

    • true：主机网络。Pod 直接使用主机的网络栈，与主机共享 IP 地址和端口。

    • false：容器网络。Pod 拥有独立的网络栈，不占用主机网络端口。

    true
    intranet

    boolean

    边缘节点池内，节点之间是否三层网络互通。

    • true：互通。该节点池内的所有节点之间三层网络互通。

    • false：不互通。该节点池内的所有主机之间三层网络不互通。

    true
    auto_mode

    object

    智能托管配置。

    enable

    boolean

    是否开启

    false
    node_components

    array<object>

    节点组件列表。

    array<object>

    节点组件。

    name

    string

    节点组件名称。

    kubelet
    version

    string

    节点组件版本。

    1.33.3-aliyun.1
    config

    object

    节点组件配置。

    custom_config

    object

    节点组件自定义配置。

    {"cpuManagerPolicy":"static"}

    any

    节点组件自定义配置字符串。

    cpuManagerPolicy
    eflo_node_group

    object

    cluster_id

    string

    i113790071760688002461
    group_id

    string

    i128147721760688002463

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.