Container Service for Kubernetes:CreateClusterNodePool

ノードプール名。

ノードプールタイプ。有効な値:

• ess: 標準ノードプール (マネージド特徴と auto scaling 機能を含む)。

• edge: エッジノードプール。

• lingjun: Lingjun ノードプール。

• hybrid: ハイブリッドクラウドノードプール。

ノードプールのリソースグループ ID。ノードプールによって作成されたインスタンスはこのリソースグループに属します。

リソースは 1 つのリソースグループにのみ属することができます。ビジネスシナリオに応じて、リソースグループをプロジェクト、アプリケーション、組織などの概念にマッピングできます。

auto scaling を有効にするかどうかを指定します。有効な値:

• true: ノードプールの auto scaling 特徴を有効にします。クラスターの容量計画がアプリケーション Pod のスケジューリングニーズを満たせない場合、ACK は構成された最小値および最大値のインスタンス数に基づいてノードリソースを自動的にスケーリングします。バージョン 1.24 以降のクラスターではデフォルトでインスタントノードスケーリングが有効になります。バージョン 1.24 より前のクラスターではデフォルトでノード auto scaling が有効になります。詳細については、ノードスケーリングを参照してください。

• false: auto scaling を無効にします。ACK はセットされた期待ノード数に基づいてノードプール内のノード数を調整し、常にノード数を期待数に維持します。

false にセットした場合、auto_scaling 内の他の構成パラメーターは効果がありません。

デフォルト値: false。

呼び出し時にエラーが発生した場合は、パラメーター値を確認してください。

auto scaling のインスタンスタイプ。enable=true の場合のみ効果があります。有効な値:

• cpu: スタンダードインスタンスタイプ。

• gpu: GPU インスタンスタイプ。

• gpushare: GPU 共有タイプ。

• spot: プリエンプティブルインスタンスタイプ。

デフォルト値: cpu。

ノードプール内のスケーラブルインスタンスの最大値 (既存のインスタンスを除く)。enable=true の場合のみ効果があります。エラーを避けるため、適切な値を設定してください。

有効値: [min_instances, 2000]。デフォルト値: 0。

ノードプール内のスケーラブルインスタンスの最小値 (既存のインスタンスを除く)。enable=true の場合のみ効果があります。

有効値: [0, max_instances]。デフォルト値: 0。

[非推奨] このフィールドは非推奨です。代わりに internet_charge_type と internet_max_bandwidth_out を使用してください。

EIP をバインドするかどうかを指定します。有効な値:

• true: EIP をバインドします。

• false: EIP をバインドしません。

デフォルト値: false。

エラーを避けるため、帯域幅の設定を確認してください。

[非推奨] 代わりに internet_charge_type と internet_max_bandwidth_out を使用してください。

EIP の課金タイプ。有効な値:

• PayByBandwidth: 固定帯域幅による課金。

• PayByTraffic: トラフィック使用量による課金。

デフォルト値: PayByBandwidth。

エラーを避けるため、正しい課金タイプを指定してください。

[非推奨] 代わりに internet_charge_type と internet_max_bandwidth_out を使用してください。

EIP のピーク帯域幅。単位: Mbps。

ノードプールのマネージド特徴を有効にするかどうかを指定します。有効な値:

• true: マネージド特徴を有効にします。

• false: マネージド特徴を無効にします。その他の関連構成は enable=true の場合のみ効果があります。

デフォルト値: false。

エラーを避けるため、適切な値を設定してください。

ノードを自動的に修復するかどうかを指定します。enable=true の場合のみ効果があります。

• true: 自動修復を有効にします。

• false: 自動修復を無効にします。

デフォルト値: true。

エラーを避けるため、enable が true に設定されていることを確認してください。

CVE 脆弱性を自動的に修正するかどうかを指定します。enable=true の場合のみ有効です。

• true: CVE の自動修正を許可します。

• false: CVE の自動修正を許可しません。

デフォルト値: true。

エラーを避けるため、enable が true に設定されていることを確認してください。

ノードを自動的にアップグレードするかどうかを指定します。enable=true の場合のみ効果があります。

• true: 自動アップグレードを有効にします。

• false: 自動アップグレードを無効にします。

デフォルト値: true。

エラーを避けるため、enable が true に設定されていることを確認してください。

ノードプールノードの課金タイプ。有効な値:

• PrePaid: サブスクリプションインスタンス。

• PostPaid: 従量課金インスタンス。

デフォルト値: PostPaid。

エラーを避けるため、正しい課金タイプを指定してスクリプトを確認してください。

ノードプールノードのサブスクリプション期間。instance_charge_type が PrePaid にセットされている場合のみ効果があり、必須です。スクリプトでインスタンスの期間を指定してください。

• period_unit=Week の場合、period の有効な値: {1, 2, 3, 4}。

• period_unit=Month の場合、period の有効な値: {1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60}。

ノードプールノードの課金期間単位。instance_charge_type が PrePaid にセットされている場合のみ効果があり、必須です。インスタンスのエラーを避けるため、正しい値を指定してください。

• Month: 月単位で課金。

• Week: 週単位で課金。

デフォルト値: Month。

ノードプールノードの自動更新を有効にするかどうかを指定します。instance_charge_type が PrePaid にセットされている場合のみ効果があります。有効な値:

• true: 自動更新を有効にします。

• false: 自動更新を無効にします。

デフォルト値: false。

インスタンスのエラーを避けるため、正しい値を指定してください。

各自動更新サイクルの持続時間。有効な値:

• PeriodUnit=Week の場合: 1, 2, 3。

• PeriodUnit=Month の場合: 1, 2, 3, 6, 12, 24, 36, 48, 60。

デフォルト値: 1。

エラーを避けるため、正しい値を指定してください。

プリエンプティブルインスタンスタイプ。有効な値:

• NoSpot: 非プリエンプティブルインスタンス。

• SpotWithPriceLimit: プリエンプティブルインスタンスの最大価格をセットします。

• SpotAsPriceGo: システムが現在の市場価格で自動的に入札します。

詳細については、プリエンプティブルインスタンスを参照してください。呼び出し時に正しい値を指定してください。

オペレーティングシステムイメージタイプ。有効な値:

• AliyunLinux: Alinux2 イメージ。

• AliyunLinuxSecurity: Alinux2 イメージ UEFI エディション。

• AliyunLinux3: Alinux3 イメージ。

• AliyunLinux3Arm64: Alinux3 イメージ ARM エディション。

• AliyunLinux3Security: Alinux3 イメージ UEFI エディション。

• CentOS: CentOS イメージ。

• Windows: Windows イメージ。

• WindowsCore: WindowsCore イメージ。

• ContainerOS: コンテナ最適化イメージ。

• AliyunLinux3ContainerOptimized: Alinux3 コンテナ最適化イメージ。

カスタムイメージ ID。デフォルトではシステム提供のイメージが使用されます。エラーを避けるため、有効なイメージ ID を指定してください。

ノードのシステムディスクタイプ。有効な値:

• cloud_efficiency: Ultra ディスク。

• cloud_ssd: SSD ディスク。

• cloud_essd: ESSD ディスク。

• cloud_auto: ESSD AutoPL ディスク。

• cloud_essd_entry: ESSD Entry ディスク。

デフォルト値: cloud_efficiency。

エラーを避けるため、正しいディスクタイプを指定してください。

ノードのシステムディスクサイズ。単位: GiB。

有効値: [20,2048]。

ノードのシステムディスクパフォーマンス。ESSD ディスクの場合のみ効果があります。ディスクのパフォーマンスレベルはディスクサイズに関連します。詳細については、ESSD ディスクを参照してください。

• PL0: 中程度の同時ピーク I/O パフォーマンスで、比較的安定した読み取り/書き込みレイテンシ。

• PL1: 中程度の同時ピーク I/O パフォーマンスで、比較的安定した読み取り/書き込みレイテンシ。

• PL2: 高い同時ピーク I/O パフォーマンスで、安定した読み取り/書き込みレイテンシ。

• PL3: 超高同時ピーク I/O パフォーマンスで、極めて安定した読み取り/書き込みレイテンシ。

システムディスクを暗号化するかどうかを指定します。有効な値:

• true: 暗号化します。

• false: 暗号化しません。

システムディスクで使用される KMS キー ID。

システムディスクで使用される暗号化アルゴリズム。有効な値: aes-256。

ノードのシステムディスクのバースト (パフォーマンスバースト) を有効にするかどうかを指定します。有効な値:

• true: 有効にします。

• false: 無効にします。

このパラメーターは system_disk_category が cloud_auto に設定されている場合のみ設定できます。詳細については、ESSD AutoPL ディスクを参照してください。

ノードのシステムディスクの事前プロビジョニング済み読み取り/書き込み IOPS。

有効値: 0~min{50,000, 1000*容量-ベースラインパフォーマンス}。ベースラインパフォーマンス=min{1,800+50*容量, 50000}。

このパラメーターは system_disk_category が cloud_auto に設定されている場合のみ設定できます。詳細については、ESSD AutoPL ディスクを参照してください。

パスワードレスログイン用のキーペア名。login_password と併用できません。

SSH ログインパスワード。key_pair と併用できません。パスワードは 8～30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。

Whether the provisioned ECS instances use non-root user login.

• true: log in as a non-root user (ecs-user).

• false: log in as root.

[Deprecated] Use the security_hardening_os parameter instead.

等級保護の強化を有効にするかどうかを指定します。システムイメージが Alibaba Cloud Linux 2 または Alibaba Cloud Linux 3 の場合のみ有効にできます。Alibaba Cloud は、Alibaba Cloud Linux 2 および Alibaba Cloud Linux 3 のレベル 3 等級保護イメージに対して、等級保護コンプライアンスベースラインチェック標準とスキャンプログラムを提供しています。

Alibaba Cloud OS security hardening. Valid values:

• true: enable Alibaba Cloud OS security hardening.

• false: disable Alibaba Cloud OS security hardening.

Default value: false.

パブリック IP の課金タイプ。有効な値:

• PayByBandwidth: 固定帯域幅による課金。

• PayByTraffic: トラフィック使用量による課金。

ノードのパブリック IP の最大アウトバウンドパブリック帯域幅。単位: Mbps (メガビット/秒)。有効値: [1,100]。

ノードプールの期待ノード数。

ノードプールが維持すべきノードの合計数。クラスターコンポーネントが正常に動作するように、少なくとも 2。

Multi-zone scaling group ECS instance scaling policy. Valid values:

• PRIORITY: scales based on the VSwitches (VSwitchIds.N) you define. When ECS instances cannot be created in the zone of a higher-priority VSwitch, the next-priority VSwitch is automatically used.

• COST_OPTIMIZED: attempts to create instances in order of vCPU unit price from lowest to highest. When the scaling configuration has multiple instance types with preemptible billing, preemptible instances are preferentially created. You can use the CompensateWithOnDemand parameter to specify whether to automatically try creating pay-as-you-go instances when preemptible instances cannot be created due to inventory or other reasons.

  説明

  COST_OPTIMIZED only takes effect when the scaling configuration has multiple instance types or uses preemptible instances.

• BALANCE: evenly distributes ECS instances across multiple zones specified by the scaling group. If zones become unbalanced due to insufficient inventory or other reasons, you can use the RebalanceInstances API to rebalance resources.

Default value: PRIORITY.

Scaling group mode. Valid values:

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

• recycle: rapid mode. Scales by creating, stopping, and starting ECS instances, improving the speed of subsequent scaling (compute resources are not charged during stop, only storage fees apply, except for local disk instance types).

Default value: release.

Minimum number of pay-as-you-go instances required by 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 preferentially created.

After the scaling group meets the minimum pay-as-you-go instance count (on_demand_base_capacity) requirement, the percentage of pay-as-you-go instances among the excess instances. Valid values: [0,100].

Number of available instance types specified. The scaling group will evenly create preemptible instances using the lowest-cost instance types. Valid values: [1,10].

Whether to enable preemptible instance supplementation. When enabled, the scaling group will attempt to create new instances to replace preemptible instances that are about to be reclaimed when the reclamation notification is received. Valid values:

• true: enable preemptible instance supplementation.

• false: disable preemptible instance supplementation.

When multi_az_policy is set to COST_OPTIMIZED, whether to allow automatically creating pay-as-you-go instances to meet the ECS instance count requirement when sufficient preemptible instances cannot be created due to price, inventory, or other reasons. Valid values:

• true: allow automatically creating pay-as-you-go instances to meet the ECS instance count requirement.

• false: do not allow automatically creating pay-as-you-go instances to meet the ECS instance count requirement.

Deployment set ID. You can use a deployment set to distribute ECS instances created by the node pool across different physical servers to ensure business high availability and underlying disaster recovery capabilities. When creating ECS instances within a deployment set, the instances are distributed across the specified region based on the pre-configured deployment strategy.

Node pool security group ID. Use either this or security_group_ids. We recommend using security_group_ids.

[Deprecated] Use the image_type parameter instead.

Operating system distribution. Valid values:

• CentOS

• AliyunLinux

• Windows

• WindowsCore

Default value: AliyunLinux.

Worker RAM role name.

• When empty, the default Worker RAM role created by the cluster is used.

• When not empty, the specified RAM role must be a normal service role, and its trusted service must be configured as Elastic Compute Service. For more information, see Create a normal service role. When the specified RAM role is not the default Worker RAM role created by the cluster, the role name cannot start with KubernetesMasterRole- or KubernetesWorkerRole-.

ECS instance metadata access configuration.

System disk snapshot policy.

Kubelet parameter configuration.

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

• containerd: recommended, supports all cluster versions.

• Sandboxed-Container.runv: secure sandbox container, provides higher isolation, supports clusters of version 1.31 and earlier.

• docker: discontinued maintenance, supports clusters of version 1.22 and earlier.

Default value: containerd.

Container runtime version.

Node CPU management policy. The following two policies are supported for cluster versions 1.12.6 and later:

• static: allows enhanced CPU affinity and exclusivity for Pods with certain resource characteristics on the node.

• none: enables the existing default CPU affinity scheme.

Default value: none.

Instance custom data. After the node joins the cluster, the specified instance custom data script will be executed. For more information, see User-Data scripts.

Whether nodes after scale-out are unschedulable.

• true: unschedulable.

• false: schedulable.

Whether to install CloudMonitor on ECS nodes. After installation, you can view monitoring information of the created ECS instances in the CloudMonitor console. We recommend enabling this. Valid values:

• true: install CloudMonitor on ECS nodes.

• false: do not install CloudMonitor on ECS nodes.

Default value: false.

Custom node name. After customizing the node name, the node name, ECS instance name, and ECS instance hostname will all be changed.

The node name consists of three parts: prefix, node IP address, and suffix:

• Total length is 2-64 characters. The node name must start and end with lowercase letters or digits.

• The prefix and suffix can contain uppercase and lowercase letters, digits, hyphens (-), and periods (.). Must start with a letter, cannot start or end with a hyphen (-) or period (.). Consecutive hyphens (-) or periods (.) are not allowed.

• Prefix is required (ECS restriction), suffix is optional.

• Node IP is the complete private IP address of the node.

For example, if the node IP address is 192.XX.YY.55, the prefix is aliyun.com, and the suffix is test:

• For Linux nodes, the node name, ECS instance name, and ECS instance hostname are all aliyun.com192.XX.YY.55test.

• For Windows nodes, the ECS instance hostname is 192-XX-YY-55, and the node name and ECS instance name are both aliyun.com192.XX.YY.55test.

Instance pre-custom data. Before the node joins the cluster, the specified instance pre-custom data script will be executed. For more information, see User-Data scripts.

Whether to enable TEE cluster.

• true: enable TEE.

• false: disable TEE.

[Deprecated]

Cloud Enterprise Network (CEN) instance ID bound to the enhanced edge node pool (CENID).

[Deprecated]

Cloud Connect Network (CCN) instance ID bound to the enhanced edge node pool (CCNID).

[Deprecated]

Region of the Cloud Connect Network (CCN) instance bound to the enhanced edge node pool.

[Deprecated]

Network bandwidth of the enhanced edge node pool. Unit: Mbps.

[Deprecated]

Purchase duration of the enhanced edge node pool. Unit: months.

Lingjun cluster ID to associate when creating a Lingjun node pool.

Lingjun group ID of the Lingjun cluster to associate when creating a Lingjun node pool.

Whether to enable intelligent managed mode. Valid values:

• true: enable intelligent managed mode. Can only be enabled when the cluster has intelligent managed mode enabled.

• false: disable intelligent managed mode.