ModifyClusterNodePool

Updated at:

The ModifyClusterNodePool operation updates the configuration of a node pool.

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:ModifyClusterNodePool

update

*Cluster

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

None None

Request syntax

PUT /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.

p31da1b38983f4511b490fc62108a****

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

nodepool_info

object

No

The node pool configurations.

name

string

No

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

resource_group_id

string

No

The ID of the resource group. Instances created in the node pool belong to this resource group.

A resource can belong to only one resource group. You can map resource groups to concepts such as projects, applications, or organizations as needed.

rg-acfmyvw3wjm****

auto_scaling

object

No

The auto scaling configurations.

enable

boolean

No

Specifies whether to enable auto scaling. Valid values:

  • true: Enables auto scaling for the node pool. If the cluster runs out of resources for pods, Container Service for Kubernetes (ACK) automatically scales nodes based on the specified minimum and maximum number of instances. For clusters that run Kubernetes 1.24 or later, instant elasticity is enabled by default. For clusters that run a Kubernetes version earlier than 1.24, node autoscaling is enabled by default. For more information, see Node scaling.

  • false: Disables auto scaling. ACK adjusts the number of nodes in the node pool to the value of `desired_size` and keeps the number of nodes unchanged.

If you set this parameter to false, other parameters in auto_scaling do not take effect.

Default value: false.

true

type deprecated

string

No

The type of auto scaling. This parameter specifies the type of instances to be scaled. Valid values:

  • cpu: regular instances.

  • gpu: GPU-accelerated instances.

  • gpushare: shared GPU-accelerated instances.

  • spot: spot instances.

Default value: cpu.

cpu

max_instances

integer

No

The maximum number of instances that can be created in the node pool. This parameter does not include existing instances. This parameter takes effect only when enable=true.

The value must be in the range of [min_instances, 2000]. The default value is 0.

10

min_instances

integer

No

The minimum number of instances that can be created in the node pool. This parameter does not include existing instances. This parameter takes effect only when enable=true.

The value must be in the range of [0, max_instances]. The default value is 0.

Note
  • If you set this parameter to a value greater than 0, the specified number of ECS instances are automatically created after the scaling group is enabled.

  • Set the maximum number of instances to a value that is greater than or equal to the current number of nodes in the node pool. Otherwise, the number of nodes in the node pool is reduced after auto scaling is enabled.

2

is_bond_eip deprecated

boolean

No

[This parameter is deprecated] This parameter is deprecated. Use internet_charge_type and internet_max_bandwidth_out instead.

  • true: associates an EIP.

  • false: does not associate an EIP.

Default value: false.

null

eip_internet_charge_type deprecated

string

No

[This parameter is deprecated] Use internet_charge_type and internet_max_bandwidth_out instead.

The billing method of the EIP. Valid values:

  • PayByBandwidth: pay-by-bandwidth.

  • PayByTraffic: pay-by-traffic.

Default value: PayByBandwidth.

null

eip_bandwidth deprecated

integer

No

[This parameter is deprecated] Use internet_charge_type and internet_max_bandwidth_out instead. The peak bandwidth of the EIP.

Value range: [1,100]. Unit: Mbit/s.

null

management

object

No

The configurations of the managed node pool.

enable

boolean

No

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

  • true: enables the managed node pool feature.

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

Default value: false.

true

auto_repair

boolean

No

Specifies whether to enable auto node repair. This parameter takes effect only when enable=true.

  • true: enables auto node repair.

  • false: disables auto node repair.

Default value: true

true

auto_repair_policy

object

No

The auto node repair policy.

restart_node

boolean

No

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

  • true: allows node restart.

  • false: does not allow node restart.

Default value: true

true

approval_required

boolean

No

Specifies whether manual approval is required for node repair.

auto_repair_policy_id

string

No

The ID of the auto repair policy.

r-xxxxxxxxxx

auto_vul_fix

boolean

No

Specifies whether to automatically fix CVE vulnerabilities. This parameter takes effect only when enable=true.

  • true: automatically fixes CVE vulnerabilities.

  • false: does not automatically fix CVE vulnerabilities.

Default value: true.

true

auto_vul_fix_policy

object

No

The policy for automatically fixing CVE vulnerabilities.

restart_node

boolean

No

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

  • true: allows node restart.

  • false: does not allow node restart.

Default value: true

true

vul_level

string

No

The vulnerability levels that are allowed to be automatically fixed. The levels are separated by commas (,). For example: asap,later. Supported vulnerability levels:

  • asap: high

  • later: medium

  • nntf: low

Default value: asap.

asap,nntf

exclude_packages

string

No

Specifies the packages that should be excluded during vulnerability fixing.

Default value: kernel.

kernel

auto_upgrade

boolean

No

Specifies whether to enable auto node upgrade. This parameter takes effect only when enable=true.

  • true: enables auto node upgrade.

  • false: disables auto node upgrade.

Default value: true

true

auto_upgrade_policy

object

No

The auto upgrade policy.

auto_upgrade_kubelet

boolean

No

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

  • true: allows auto kubelet upgrade.

  • false: does not allow auto kubelet upgrade.

Default value: true

true

auto_upgrade_runtime

boolean

No

Specifies whether to allow auto runtime upgrade. This parameter takes effect only when auto_upgrade=true. Valid values:

  • true: allows auto runtime upgrade.

  • false: does not allow auto runtime upgrade.

Default value: true.

false

auto_upgrade_os

boolean

No

Specifies whether to allow auto operating system upgrade. This parameter takes effect only when auto_upgrade=true. Valid values:

  • true: allows auto operating system upgrade.

  • false: does not allow auto operating system upgrade.

Default value: false.

false

upgrade_config deprecated

object

No

[This parameter is deprecated] Use the auto_upgrade parameter at the upper level instead.

The auto upgrade configurations. This parameter takes effect only when enable=true.

auto_upgrade deprecated

boolean

No

[This parameter is deprecated] Use the auto_upgrade parameter at the upper level instead.

Specifies whether to enable auto upgrade:

  • true: enabled.

  • false: disabled.

Default value: true.

true

surge

integer

No

The number of extra nodes. You can specify only one of surge and surge_percentage.

Nodes may become unavailable during an upgrade. You can create extra nodes to compensate for the workload.

Note

The number of extra nodes cannot exceed the total number of nodes in the node pool.

5

surge_percentage

integer

No

The percentage of extra nodes. You can specify only one of surge and surge_percentage.

Number of extra nodes = Percentage of extra nodes × Number of nodes. For example, if you set the percentage of extra nodes to 50% and the number of existing nodes is 6, the number of extra nodes is 50% × 6 = 3.

0

max_unavailable

integer

No

The maximum number of unavailable nodes.

Value range: [1,1000]

Default value: 1.

1

auto_fault_diagnosis

boolean

No

scaling_group

object

No

The configurations of the scaling group for the node pool.

vswitch_ids

array

No

A list of vSwitch IDs. The value can be a list of 1 to 8 vSwitch IDs.

Note

For high availability, we recommend that you select vSwitches in different zones.

string

No

The vSwitch ID.

vsw-wz9uwxhawmtzg7u9h****

instance_types

array

No

A list of node instance types. You can select multiple instance types as alternatives. When a node is created, the system 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 inventory.

The number of supported instance types ranges from 1 to 10.

string

No

The instance type. For more information, see Instance families.

ecs.c6.large

instance_charge_type

string

No

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

  • PrePaid: subscription

  • PostPaid: pay-as-you-go

Default value: PostPaid.

PostPaid

period

integer

No

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

  • If period_unit=Week, the valid values of period are {1, 2, 3, 4}.

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

1

period_unit

string

No

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

  • Month: The billing cycle is measured in months.

  • Week: The billing cycle is measured in weeks.

Default value: Month.

Month

auto_renew

boolean

No

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

  • true: enables auto-renewal.

  • false: disables auto-renewal.

Default value: false.

true

auto_renew_period

integer

No

The auto-renewal period. Valid values:

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

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

Default value: 1.

1

spot_strategy

string

No

The bidding policy for spot instances. Valid values:

  • NoSpot: The instance is a regular pay-as-you-go instance.

  • SpotWithPriceLimit: You set a maximum hourly price for the instance.

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

For more information, see Spot instances.

SpotWithPriceLimit

spot_price_limit

array<object>

No

The price range of the spot instance.

object

No

The price range of the spot instance.

instance_type

string

No

The instance type of the spot instance.

ecs.c6.large

price_limit

string

No

The maximum price of a single instance.

Unit: CNY/hour.

0.39

image_type

string

No

The OS distribution. We recommend that you use this parameter to specify the node OS. Valid values:

  • AliyunLinux: Alinux2 image.

  • AliyunLinuxSecurity: Alinux2 image UEFI version.

  • AliyunLinux3: Alinux3 image.

  • AliyunLinux3Arm64: Alinux3 image ARM version.

  • AliyunLinux3Security: Alinux3 image UEFI version.

  • CentOS: CentOS image.

  • Windows: Windows image.

  • WindowsCore: WindowsCore image.

  • ContainerOS: ContainerOS image.

  • AliyunLinux3ContainerOptimized: Alinux3 image container-optimized version.

AliyunLinux3

image_id

string

No

The ID of the custom image. You can call the DescribeKubernetesVersionMetadata operation to query the images supported by the system. By default, the latest system image is used.

aliyun_3_x64_20G_alibase_20241218.vhd

system_disk_category

string

No

The type of the system disk. Valid values:

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

  • cloud_auto: ESSD AutoPL disk.

  • cloud_essd_entry: ESSD Entry disk.

Default value: cloud_efficiency.

cloud_efficiency

system_disk_categories

array

No

The multi-disk type of the system disk. When a disk of a higher priority type is not available, the system automatically tries the next priority type to create the system disk.

string

No

The multi-disk type of the node system.

Valid values:

  • cloud_efficiency: ultra disk.

  • cloud_ssd: standard SSD.

  • cloud_essd: ESSD.

  • cloud_auto: ESSD AutoPL disk.

  • cloud_essd_entry: ESSD Entry disk.

cloud_essd

system_disk_size

integer

No

The size of the system disk. Unit: GiB.

Value range: [20,2048].

The value of this parameter must be greater than or equal to max{20, ImageSize}.

Default value: max{40, ImageSize of the image specified by the ImageId parameter}.

120

system_disk_performance_level

string

No

The performance level of the system disk. This parameter is valid only for ESSDs. The disk performance level is related to the disk size. For more information, see ESSDs.

  • PL0: medium concurrent I/O performance, stable read and write latency.

  • PL1: medium concurrent I/O performance, stable read and write latency.

  • PL2: high concurrent I/O performance, stable read and write latency.

  • PL3: extremely high concurrent I/O performance, extremely stable read and write latency.

PL1

system_disk_encrypted

boolean

No

Specifies whether to encrypt the system disk. Valid values:

  • true: encrypts the system disk.

  • false: does not encrypt the system disk.

false

system_disk_kms_key_id

string

No

The ID of the KMS key that is used to encrypt the system disk.

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

system_disk_encrypt_algorithm

string

No

The encryption algorithm that is used for the system disk. Valid value: aes-256.

aes-256

system_disk_provisioned_iops

integer

No

The pre-configured read and write IOPS of the system disk.

Valid values: 0 to min{50,000, 1000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50000}.

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

1000

system_disk_bursting_enabled

boolean

No

Specifies whether to enable the performance burst feature for the system disk. Valid values:

  • true: enables the performance burst feature. After this feature is enabled, the cloud disk can temporarily improve its performance to handle unexpected data read and write pressure when the business is in a fluctuating state, until the business returns to a stable state.

  • false: disables the performance burst feature.

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

true

data_disks

array

No

The configurations of the data disks on the nodes. You can add up to 10 data disks. The value must be in the range of [0, 10].

data_disk

No

The configurations of the data disk.

disk_init

array

No

The block device initialization configuration.

DiskInit

No

The block device initialization configuration.

key_pair

string

No

The name of the key pair. You must set key_pair or login_password. If the node pool is a managed node pool, only key_pair is supported.

pro-nodepool

login_password

string

No

The SSH logon password. You must set key_pair or login_password. 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.

Hello1234

internet_charge_type

string

No

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

  • PayByBandwidth: pay-by-bandwidth.

  • PayByTraffic: pay-by-traffic.

PayByBandwidth

internet_max_bandwidth_out

integer

No

The maximum outbound bandwidth of the public IP address of the node. Unit: Mbit/s. Value range: [1,100].

5

tags

array

No

The tags that you want to add only to ECS instances.

A tag key cannot be repeated. The tag key can be up to 128 characters in length. The tag key and the tag value cannot start with “aliyun” or “acs:”, or contain “https://” or “http://”.

tag

No

The tag of the ECS instance.

desired_size

integer

No

The expected number of nodes in the node pool.

The total number of nodes that the node pool should maintain. We recommend that you configure at least two nodes to ensure that the cluster components run as normal. You can scale out or scale in the node pool by adjusting the expected number of nodes.

If you do not want to create nodes, set this parameter to 0. You can manually adjust the number of nodes later.

2

multi_az_policy

string

No

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

  • PRIORITY: scales instances based on the vSwitch priority (VSwitchIds.N). The system preferentially creates ECS instances in the zone of the vSwitch that has the highest priority. If the ECS instances cannot be created in the zone, the system creates the ECS instances in the zone of the vSwitch that has the next highest priority.

  • COST_OPTIMIZED: creates instances based on the vCPU unit price in ascending order. When the scaling configuration is set to create spot instances, the system preferentially creates spot instances. You can also use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when spot instances cannot be created due to reasons such as insufficient inventory.

    Note

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

  • BALANCE: evenly distributes ECS instances among the specified zones. If the distribution of ECS instances becomes unbalanced due to insufficient inventory, you can call the RebalanceInstances operation to rebalance the resources. For more information, see RebalanceInstances .

Default value: PRIORITY.

BALANCE

scaling_policy

string

No

The scaling mode of the scaling group. Valid values:

  • release: the standard mode. This mode creates or releases ECS instances to perform scaling activities.

  • recycle: the quick mode. This mode creates, stops, or starts ECS instances to perform scaling activities. This improves the scaling speed. When an instance is stopped, its computing resources are not billed, but its storage resources are. This does not apply to instance types that have local disks.

release

on_demand_base_capacity

integer

No

The minimum number of on-demand instances that must be provisioned in the scaling group. Value range: [0,1000]. When the number of on-demand instances is less than this value, the system preferentially creates on-demand instances.

0

on_demand_percentage_above_base_capacity

integer

No

The percentage of on-demand instances among the instances that exceed the minimum number of on-demand instances (on_demand_base_capacity). Value range: [0,100].

20

spot_instance_pools

integer

No

The number of available instance types. The scaling group creates spot instances of multiple instance types that are available at the lowest cost. Value range: [1,10].

5

spot_instance_remedy

boolean

No

Specifies whether to enable the instance replacement feature for spot instances. If this feature is enabled, the scaling group creates a new instance to replace a spot instance when the scaling group receives a system message that the spot instance is to be reclaimed. Valid values:

  • true: enables the instance replacement feature for spot instances.

  • false: disables the instance replacement feature for spot instances.

false

compensate_with_on_demand

boolean

No

If multi_az_policy is set to COST_OPTIMIZED, specifies whether to allow the system to automatically create pay-as-you-go instances to meet the required number of ECS instances when spot instances cannot be created due to reasons such as price and inventory. Valid values:

  • true: allows the system to automatically create pay-as-you-go instances to meet the required number of ECS instances.

  • false: does not allow the system to automatically create pay-as-you-go instances to meet the required number of ECS instances.

true

rds_instances

array

No

A list of RDS instances.

string

No

The ID of the RDS instance. If you specify a list of RDS instances, the ECS instances in the cluster are automatically added to the whitelist of the RDS instances.

rds-xxx

private_pool_options

object

No

The configurations of the private node pool.

id

string

No

The ID of the private node pool. If match_criteria is set to Target, you must specify the ID of a private pool.

eap-bp67acfmxazb4****

match_criteria

string

No

The type of the private node pool. This parameter specifies the private pool capacity option for instance creation. The capacity of a private pool is generated after an elasticity assurance or a capacity reservation service takes effect. You can select a capacity option when you create an instance. Valid values:

  • Open: open mode. The system automatically matches the capacity of open private pools. If no matching private pool is found, the resources in the public pool are used.

  • Target: specified mode. The system uses the capacity of the specified private pool to create the instance. If the specified private pool is unavailable, the instance fails to be created.

  • None: no mode. The capacity of private pools is not used.

Open

platform deprecated

string

No

[This parameter is deprecated] Use the image_type parameter instead.

The OS platform. Valid values:

  • AliyunLinux

  • CentOS

  • Windows

  • WindowsCore

AliyunLinux

instance_patterns

array

No

The instance attribute configuration.

instance_patterns

No

The instance attributes.

deploymentset_id

string

No

The ID of the deployment set to which the ECS instances in the node pool belong. This parameter takes effect only for incremental nodes. The deployment sets of existing nodes are not changed.

ds-bp1d19mmbsv3jf6xxxxx

security_group_ids

array

No

A list of security group IDs.

string

No

The security group ID.

sg-wz9a8g2mt6x5ll******

resource_pool_options

object

No

The resource pool and resource pool policy that are used when you create an instance. Note: This parameter is valid only when you create a pay-as-you-go instance. This parameter cannot be specified at the same time as private_pool_options.match_criteria and private_pool_options.id.

strategy

string

No

The resource pool policy that is used when you create an instance. A resource pool includes a private pool that is generated after an elasticity assurance or a capacity reservation service takes effect and a public pool. You can select a resource pool when you create an instance. Valid values: PrivatePoolFirst: The private pool is used first. If you specify resouce_pool_options.private_pool_ids, the specified private pool is used first. If you do not specify a private pool or the capacity of the specified private pool is insufficient, the capacity of open private pools is automatically matched. If no matching private pool is found, the resources in the public pool are used to create the instance. PrivatePoolOnly: Only the private pool is used. If you select this option, you must specify resouce_pool_options.private_pool_ids. If the capacity of the specified private pool is insufficient, the instance fails to be created. None: No resource pool policy is used. Default value: None.

PrivatePoolFirst

private_pool_ids

array

No

A list of private pool IDs. The IDs can be the IDs of elasticity assurances or capacity reservations. You can specify only the IDs of private pools in Target mode. N can be an integer from 1 to 20.

string

No

The ID of the private pool. The ID can be the ID of an elasticity assurance or a capacity reservation. You can specify only the ID of a private pool in Target mode.

eap-bp67acfmxazb4****

system_disk_snapshot_policy_id

string

No

The snapshot policy for the system disk.

sp-0jl6xnmme8v7o935****

kubernetes_config

object

No

The Kubernetes configurations.

labels

array

No

The labels that you want to add to the nodes. The labels must be key-value pairs. Rules:

  • The labels must be case-sensitive key-value pairs. You can add up to 20 labels.

  • The key of a label cannot be repeated. The key can be up to 64 characters in length, and the value can be up to 128 characters in length. The key and value cannot start with aliyun, acs:, https://, or http://. For more information, see Labels and Selectors.

tag

No

The node label.

taints

array

No

The node taint configurations.

taint

No

The node taint configuration.

runtime

string

No

The name of the container runtime. ACK supports the following container runtimes.

  • containerd: recommended. This runtime is supported by all cluster versions.

  • Sandboxed-Container.runv: a sandboxed container that provides higher isolation. This runtime is supported by clusters of Kubernetes 1.31 and earlier.

  • docker: no longer maintained. This runtime is supported by clusters of Kubernetes 1.22 and earlier.

Default value: containerd.

containerd

runtime_version

string

No

The version of the container runtime.

1.6.38

cpu_policy

string

No

The CPU management policy of the node. The following policies are supported for clusters that run Kubernetes 1.12.6 or later:

  • static: allows pods with specific resource characteristics on a node to be granted enhanced CPU affinity and exclusivity.

  • none: enables the existing default CPU affinity scheme.

Default value: none.

none

unschedulable

boolean

No

Specifies whether the scaled-out nodes are unschedulable.

  • true: unschedulable.

  • false: schedulable.

false

user_data

string

No

The instance user data. After a node is added to the cluster, the specified instance user data script is run. For more information, see User data scripts.

IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi

cms_enabled

boolean

No

Specifies whether to install Cloud Monitor on the ECS nodes. After Cloud Monitor is installed, you can view monitoring information about the created ECS instances in the Cloud Monitor console. We recommend that you enable this feature. Valid values:

  • true: installs Cloud Monitor on ECS nodes.

  • false: does not install Cloud Monitor on ECS nodes.

Default value: false.

true

pre_user_data

string

No

The pre-custom data of the instance. Before a node is added to the cluster, the specified instance pre-custom data script is run. For more information, see User data scripts.

IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi

node_name_mode

string

No

The parameter for customizing the node name. A node name consists of three parts: a prefix, the node IP address, and a suffix.

The prefix and suffix can each contain one or more parts separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or a digit. The node IP address is the complete private IP address of the node.

The parameter consists of four parts separated by commas (,). For example, if you pass the string "customized,aliyun,ip,com" (where "customized" and "ip" are fixed strings, "aliyun" is the prefix, and "com" is the suffix), the node name is aliyun.192.168.xxx.xxx.com.

customized,aliyun,ip,com

tee_config

object

No

The configurations of the Kubernetes cluster for confidential computing.

tee_enable

boolean

No

Specifies whether to enable the Kubernetes cluster for confidential computing. Valid values:

  • true: enabled.

  • false: disabled.

Default value: false.

false

update_nodes

boolean

No

Synchronously updates the labels and taints of nodes.

true

concurrency

boolean

No

Specifies whether to run the task concurrently.

true

Response elements

Element

Type

Description

Example

object

The response body.

task_id

string

The task ID.

T-5fd211e924e1d00787000293

nodepool_id

string

The node pool ID.

np737c3ac1ac684703b9e10673aa2c****

request_id

string

The request ID.

687C5BAA-D103-4993-884B-C35E4314****

Examples

Success response

JSON format

{
  "task_id": "T-5fd211e924e1d00787000293",
  "nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.