すべてのプロダクト
Search
ドキュメントセンター

Container Service for Kubernetes:DescribeClusterNodePools

最終更新日:Jul 10, 2026

クラスター内のすべてのノードプールのリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:DescribeClusterNodePools

get

*Cluster

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

なし なし

リクエスト構文

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

パスパラメータ

パラメーター

必須 / 任意

説明

ClusterId

string

必須

クラスターの ID。

cc0f87de0b8fb403f86e10e204f83****

リクエストパラメーター

パラメーター

必須 / 任意

説明

NodepoolName

string

任意

ノードプール名。

nodepool-test

レスポンスフィールド

フィールド

説明

object

ノードプールの詳細。

nodepools

array<object>

ノードプールインスタンスのリスト。

array<object>

ノードプールインスタンスの詳細。

nodepool_info

object

ノードプール情報。

nodepool_id

string

ノードプールの ID。

np615c0e0966124216a0412e10afe0****

name

string

ノードプール名。

default-nodepool

type

string

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

  • ess: 標準ノードプール (マネージドおよび自動スケーリングの特徴を含む)。

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

  • lingjun: Lingjun ノードプール。

ess

is_default

boolean

ノードプールがデフォルトノードプールであるかどうかを示します。通常、クラスターにはデフォルトノードプールが 1 つだけ存在します。有効な値:

  • true: ノードプールはデフォルトノードプールです。

  • false: ノードプールはデフォルトノードプールではありません。

true

resource_group_id

string

リソースグループの ID。

rg-acfmyvw3wjm****

region_id

string

リージョン ID。

cn-beijing

created

string

ノードプールが作成された時間。

2025-04-15T16:33:29.362888807+08:00

updated

string

ノードプールが最後に更新された時間。

2025-04-15T16:33:32.823+08:00

status

object

ノードプールのステータス。

state

string

ノードプールのステータス。有効な値:

  • active: ノードプールはアクティブな状態です。

  • scaling: ノードプールはスケーリング中です。

  • removing: ノードの削除中です。

  • deleting: ノードプールの削除中です。

  • updating: ノードプールの更新中です。

active

healthy_nodes

integer

正常なインスタンスの数。

3

initial_nodes

integer

作成中のノードの数。

0

failed_nodes

integer

失敗したインスタンスの数。

0

offline_nodes

integer

オフラインノードの数。

0

removing_nodes

integer

削除中のノードの数。

0

serving_nodes

integer

サービス提供状態にあるノードの数。

3

total_nodes

integer

ノードプール内のノードの総数。

3

auto_scaling

object

auto scaling のスケーリング設定。

enable

boolean

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

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

  • false: auto scaling を無効にします。ACK は構成された希望ノード数に基づいてノードプール内のノード数を調整し、ノード数を希望値に維持します。

値が false の場合、auto_scaling 内の他の構成パラメーターは効果を持ちません。

true

type

string

インスタンスタイプ別に分類された auto scaling タイプ。有効な値:

  • cpu: 通常のインスタンスタイプ。

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

  • gpushare: GPU 共有タイプ。

  • spot: スポットインスタンスタイプ。

cpu

max_instances

integer

ノードプールでスケーリング可能なインスタンスの最大値 (既存のインスタンスを除く)。

10

min_instances

integer

ノードプールでスケーリング可能なインスタンスの最小値 (既存のインスタンスを除く)。

2

eip_internet_charge_type

string

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

  • PayByBandwidth: 帯域幅課金。

  • PayByTraffic: トラフィック課金。

PayByBandwidth

is_bond_eip

boolean

EIP が関連付けられているかどうかを指定します。有効な値:

  • true: EIP が関連付けられています。

  • false: EIP は関連付けられていません。

true

eip_bandwidth

integer

EIP のピーク帯域幅。

有効な値: [1,100]。単位: Mbit/s。

5

management

object

マネージドノードプールの構成。この構成は、プロフェッショナルマネージドクラスターでのみ効果を持ちます。

enable

boolean

マネージドノードプールが有効かどうかを指定します。有効な値:

  • true: マネージドノードプールを有効にします。

  • false: マネージドノードプールを無効にします。その他の関連構成は、enable=true の場合にのみ効果を持ちます。

true

auto_repair

boolean

自動修復が有効かどうかを指定します。このパラメーターは、enable=true の場合にのみ効果を持ちます。

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

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

true

auto_repair_policy

object

自動修復ノードポリシー。

restart_node

boolean

ノードの再起動が許可されているかどうかを指定します。このパラメーターは、auto_repair=true の場合にのみ効果を持ちます。

  • true: ノードの再起動が許可されています。

  • false: ノードの再起動は許可されていません。

true

approval_required

boolean

ノード修復に手動承認が必須かどうかを示します。

false

auto_repair_policy_id

string

自動修復ポリシーの ID。

r-xxxxxxxxx

auto_vul_fix

boolean

自動 CVE 修正が有効かどうかを指定します。このパラメーターは、enable=true の場合にのみ効果を持ちます。

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

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

true

auto_vul_fix_policy

object

自動 CVE 修正ポリシー。

restart_node

boolean

ノードの再起動が許可されているかどうかを指定します。このパラメーターは、auto_vul_fix=true の場合にのみ効果を持ちます。有効な値:

  • true: ノードの再起動が許可されています。

  • false: ノードの再起動は許可されていません。

true

vul_level

string

自動修正が許可される脆弱性レベル (カンマ区切り)。

  • asap: 高

  • later: 中間

  • nntf: 低

asap,nntf

exclude_packages

string

脆弱性修正中に除外するパッケージ。

kernel

auto_upgrade

boolean

ノードの自動スペックアップが有効かどうかを指定します。このパラメーターは、enable=true の場合にのみ効果を持ちます。

  • true: 自動スペックアップを有効にします。

  • false: 自動スペックアップを無効にします。

true

auto_upgrade_policy

object

自動スペックアップポリシー。

auto_upgrade_kubelet

boolean

kubelet の自動スペックアップが許可されているかどうかを指定します。このパラメーターは、auto_upgrade=true の場合にのみ効果を持ちます。有効な値:

  • true: kubelet の自動スペックアップが許可されています。

  • false: kubelet の自動スペックアップは許可されていません。

true

upgrade_config

object

自動スペックアップの構成。このパラメーターは、enable=true の場合にのみ有効になります。

auto_upgrade

boolean

自動スペックアップが有効かどうかを指定します。有効な値:

  • true: 自動スペックアップを有効にします。

  • false: 自動スペックアップを無効にします。

true

surge

integer

追加ノードの数。このパラメーターまたは surge_percentage のいずれかを指定します。

5

surge_percentage

integer

追加ノードの割合。このパラメーターまたは surge のいずれかを指定します。

追加ノード数 = 追加ノードの割合 × ノード数。たとえば、追加ノードの割合が 50% に設定されており、既存のノードが 6 つある場合、追加ノード数 = 50% × 6 = 3 となります。

50

max_unavailable

integer

利用不可ノードの最大値。有効な値: [1,1000]。

デフォルト値: 1。

1

auto_fault_diagnosis

boolean

scaling_group

object

ノードプールのスケーリンググループ構成。

scaling_group_id

string

スケーリンググループの ID。

asg-2ze8n5qw4atggut8****

vswitch_ids

array

vSwitch ID のリスト。

string

vSwitch の ID。

vsw-2ze3ds0mdip0hdz8i****

instance_types

array

ノードインスタンスタイプのリスト。代替として複数のインスタンスタイプを選択できます。ノード作成時、システムは最初のスペックから順にインスタンスの購入を試み、作成が成功するまで続けます。実際に購入されるインスタンスタイプは、在庫の可用性によって異なる場合があります。

ecs.n4.large

string

ノードのインスタンスタイプ。

ecs.n4.large

instance_charge_type

string

ノードプール内のノードの課金方法。有効な値:

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

  • PostPaid: 従量課金。

PostPaid

period

integer

インスタンスのサブスクリプション期間。このパラメーターは、instance_charge_typePrePaid に設定されている場合にのみ効果を持ち、必須となります。

  • 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}。

1

period_unit

string

インスタンスのサブスクリプションの課金サイクル単位。このパラメーターは、instance_charge_typePrePaid に設定されている場合に指定する必要があります。

  • Month: 月。

  • Week: 週。

Month

auto_renew

boolean

インスタンスの自動更新が有効かどうかを指定します。このパラメーターは、instance_charge_typePrePaid に設定されている場合にのみ効果を持ちます。有効な値:

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

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

false

auto_renew_period

integer

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

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

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

0

spot_strategy

string

スポットインスタンスのタイプ。有効な値:

  • NoSpot: 非スポットインスタンス。

  • SpotWithPriceLimit: 値幅制限付きスポットインスタンス。

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

詳細については、「スポットインスタンス」を参照してください。

NoSpot

spot_price_limit

array<object>

スポットインスタンスの有効値構成。

object

スポットインスタンスの有効値構成。インスタンスタイプごとに異なる有効値を設定できます。

instance_type

string

スポットインスタンスタイプ。

ecs.c6.large

price_limit

string

インスタンスあたりの値幅制限。

単位: USD/時間。

0.39

image_type

string

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

  • AliyunLinux: Alinux2 イメージ。

  • AliyunLinuxSecurity: Alinux2 UEFI イメージ。

  • AliyunLinux3: Alinux3 イメージ。

  • AliyunLinux3Arm64: Alinux3 ARM イメージ。

  • AliyunLinux3Security: Alinux3 UEFI イメージ。

  • CentOS: CentOS イメージ。

  • Windows: Windows イメージ。

  • WindowsCore: WindowsCore イメージ。

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

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

AliyunLinux3

image_id

string

カスタムイメージの ID。DescribeKubernetesVersionMetadata を呼び出して、システムでサポートされているイメージをクエリできます。

aliyun_3_x64_20G_alibase_20241218.vhd

system_disk_category

string

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

  • cloud_efficiency: ウルトラクラウドディスク。

  • cloud_ssd: 標準 SSD。

  • cloud_essd: ESSD。

  • cloud_auto: ESSD AutoPL クラウドディスク。

  • cloud_essd_entry: ESSD Entry クラウドディスク。

cloud_efficiency

system_disk_categories

array

システムクラウドディスク用の複数のクラウドディスクタイプ。優先度の高いクラウドディスクタイプが利用できない場合、システムは自動的に次の優先度のクラウドディスクタイプを使用してシステムクラウドディスクを作成します。

string

ノードシステムクラウドディスクのタイプ。

有効な値:

  • cloud_efficiency: ウルトラクラウドディスク。

  • cloud_ssd: 標準 SSD。

  • cloud_essd: ESSD。

  • cloud_auto: ESSD AutoPL クラウドディスク。

  • cloud_essd_entry: ESSD Entry クラウドディスク。

EESSD云盘

system_disk_size

integer

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

有効な値: [20,2048]。

120

system_disk_performance_level

string

ノードシステムクラウドディスクのパフォーマンスレベル。このパラメーターは ESSD クラウドディスクに対してのみ効果を持ちます。パフォーマンスレベルはクラウドディスクのサイズによって異なります。詳細については、「ESSD クラウドディスク」を参照してください。

  • PL0: 安定した読み取り/書き込みレイテンシを備えた中程度の同時 I/O パフォーマンス。

  • PL1: 安定した読み取り/書き込みレイテンシを備えた中程度の同時 I/O パフォーマンス。

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

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

PL1

system_disk_encrypted

boolean

システムクラウドディスクが暗号化されているかどうかを指定します。有効な値:

  • true: 暗号化済み。

  • false: 暗号化されていない。

false

system_disk_kms_key_id

string

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

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

system_disk_encrypt_algorithm

string

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

aes-256

system_disk_bursting_enabled

boolean

ノードシステムクラウドディスクで Burst (バースト機能) が有効かどうかを指定します。有効な値:

  • true: 有効。有効にすると、クラウドディスクは突然のデータ読み取り/書き込み負荷が発生した際に一時的にパフォーマンスを向上させ、作業が安定するまで維持します。

  • false: 無効。

このパラメーターは、system_disk_categorycloud_auto に設定されている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」を参照してください。

true

system_disk_provisioned_iops

integer

ノードシステムクラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。クラウドディスクタイプが cloud_auto の場合にこのパラメーターを設定します。

1000

data_disks

array

ノード用のデータクラウドディスクのディスクタイプ、サイズ、およびその他の構成の組み合わせ。

data_disk

ノードのデータクラウドディスク構成。

disk_init

array

ブロックデバイスの初期化構成。

DiskInit

DiskInit の構成。

security_group_ids

array

ノードプールのセキュリティグループ ID のリスト。

string

ノードプールのセキュリティグループ ID のリスト。

sg-2ze1iuk12m2sb4c4****

key_pair

string

キーペア名。このパラメーターまたは login_password のいずれかを指定します。

マネージドノードプールでは、key_pair のみがサポートされています。

pro-nodepool

login_password

string

SSH ログインパスワード。このパラメーターまたは key_pair のいずれかを指定します。パスワードの長さは 8~30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。

セキュリティ上の理由から、パスワードはクエリ結果内で暗号化されます。

******

login_as_non_root

boolean

スケールアウトされた ECS インスタンスで非ルートログインを使用するかどうかを指定します。

  • true: 非ルートユーザー (ecs-user) としてログインします。

  • false: ルートユーザーとしてログインします。

true

cis_enabled deprecated

boolean

[このフィールドは非推奨です]

代わりに security_hardening_os パラメーターを使用してください。

false

soc_enabled

boolean

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

false

security_hardening_os

boolean

Alibaba Cloud OS セキュリティ強化を有効にするかどうかを指定します。有効な値:

  • true: 有効。

  • false: 無効。

デフォルト値: false

false

internet_charge_type

string

ノードのパブリック IP アドレスの課金方法。有効な値:

  • PayByBandwidth: 固定帯域幅課金。

  • PayByTraffic: データ転送量課金。

PayByBandwidth

internet_max_bandwidth_out

integer

ノードの最大アウトバウンドパブリック帯域幅。単位: Mbit/s。有効な値: 1~100。

10

tags

array

ECS インスタンスタグ。

tag

ノードタグ。

[{\"key\":\"pkg.E2EClient.ClusterId\",\"value\":\"troopers-\"}]

desired_size

integer

ノードプールの希望ノード数。

2

multi_az_policy

string

スケーリンググループ内の ECS インスタンスのマルチゾーンスケーリングポリシー。有効な値:

  • PRIORITY: 定義した vSwitch (VSwitchIds.N) に基づいてスケーリングします。最も優先度の高い vSwitch のゾーンで ECS インスタンスを作成できない場合、システムは自動的に次の優先度の vSwitch を使用して ECS インスタンスを作成します。

  • COST_OPTIMIZED: vCPU の単価に基づき、昇順でインスタンスを作成します。スケーリング設定で複数のインスタンスタイプにスポット課金方法が指定されている場合、

COST_OPTIMIZED

scaling_policy

string

スケーリンググループパターン。有効な値:

  • release: 標準パターン。リソース使用量に基づいて ECS インスタンスを作成およびリリースすることでスケーリングします。

  • recycle: Swift パターン。ECS インスタンスを作成、停止、起動することでスケーリングし、後続のスケーリング操作を高速化します。停止中のインスタンスには計算リソースの料金は発生しませんが、ローカルディスクを持つインスタンスを除き、ストレージ料金は引き続き発生します。

release

on_demand_base_capacity

integer

スケーリンググループに必要な従量課金インスタンスの最小値。有効な値: [0,1000]。従量課金インスタンスの数がこの値未満の場合、従量課金インスタンスが優先的に作成されます。

0

on_demand_percentage_above_base_capacity

integer

従量課金インスタンスの最小値 (on_demand_base_capacity) を超える追加インスタンスにおける従量課金インスタンスの割合。有効な値: [0,100]。

20

spot_instance_pools

integer

The number of available instance types. The scaling group creates spot instances across multiple lowest-cost instance types 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 reclaimed. Valid values:

  • true: Enabled.

  • false: Disabled.

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: Allows automatic creation of pay-as-you-go instances to meet the required number of ECS instances.

  • false: Does not allow automatic creation of pay-as-you-go instances to meet the required number of ECS instances.

true

deploymentset_id

string

The deployment set ID.

ds-bp1d19mmbsv3jf6xxxxx

rds_instances

array

If RDS instances are specified, the ECS instances in the cluster are automatically added to the whitelists of the specified RDS instances.

string

The RDS instance.

rm-xxx

private_pool_options

object

The private pool options.

id

string

The private pool ID, which is the elasticity assurance ID or capacity reservation ID.

eap-bp67acfmxazb4****

match_criteria

string

The private pool type. Specifies the private pool 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. The system automatically matches an open private pool. If no matching private pool is available, public pool resources are used.

  • Target: Specified mode. The instance is launched using the specified private pool. If the specified private pool is unavailable, the instance fails to launch.

  • None: None mode. The instance does not use private pool capacity.

Open

security_group_id

string

[Deprecated]

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

sg-2ze1iuk12m2sb4c4****

platform

string

[Deprecated]

The operating system distribution. Valid values:

  • CentOS

  • AliyunLinux

  • Windows

  • WindowsCore

AliyunLinux

ram_policy

string

This field is deprecated. Use ram_role_name instead.

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

instance_patterns

array

The instance attribute configurations.

instance_patterns

The instance attributes.

ram_role_name

string

The worker RAM role name.

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

resource_pool_options

object

The resource pool and resource pool policy used for instance creation.

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

private_pool_ids

array

The list of private pool IDs.

string

The private pool ID.

eap-bp1c1fohub5jccwi****

system_disk_snapshot_policy_id

string

The snapshot policy for the system cloud disk.

sp-0jl6xnmme8v7o935****

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

ノードタグ。

tag

The label configuration.

{}

taints

array

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

taint

The node taint information.

runtime

string

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

  • containerd: Recommended. Supports all cluster versions.

  • Sandboxed-Container.runv: Sandboxed container that provides higher isolation. Supports cluster versions 1.31 and earlier.

  • docker: No longer maintained. Supports cluster versions 1.22 and earlier.

containerd

runtime_version

string

The container runtime version.

1.6.38

cpu_policy

string

The node CPU management policy. The following two policies are supported for clusters running version 1.12.6 or 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 node pool custom data, which is a script that runs after node initialization. For more information, see Generate instance user data.

IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****

unschedulable

boolean

Specifies whether scaled-out nodes are unschedulable.

  • 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: Installs the CloudMonitor agent on ECS nodes.

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

true

node_name_mode

string

The custom node name.

A 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 to extract 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 node pool pre-initialization custom data, which is a script that runs before node initialization. For more information, see Generate instance user data.

IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD

tee_config

object

The confidential computing configuration.

tee_enable

boolean

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

  • true: Enabled.

  • false: Disabled.

false

interconnect_config

object

[This field is deprecated]

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

cen_id

string

[Deprecated]

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

cen-ey9k9nfhz0f*******

ccn_id

string

[Deprecated]

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

ccn-qm5i0i0q9yi*******

ccn_region_id

string

[Deprecated]

The region of the CCN instance bound to the enhanced edge node pool.

cn-shanghai

bandwidth

integer

[Deprecated]

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

10

improved_period

string

[Deprecated]

The purchase duration of the enhanced edge node pool. Unit: months.

1

max_nodes

integer

The maximum number of nodes allowed in the edge node pool. This value must be greater than or equal to 0. A value of 0 indicates no additional limit (limited only by the overall cluster node capacity, with no additional limit on the node pool itself). Edge node pools typically have a value greater than 0. ESS-type node pools and default edge-type node pools have a value of 0.

10

interconnect_mode

string

The network type of the edge node pool. This parameter takes effect only for node pools whose type is edge. Valid values:

  • basic: public network. Nodes in cloud node pool interact with cloud nodes over the Internet. Applications in cloud node pool cannot directly access the cloud VPC internal network.

  • private: private network. Nodes in cloud node pool connect to the cloud through Express Connect, VPN, or CEN, providing higher cloud-edge communication quality and more effective security.

basic

auto_mode

object

The intelligent managed configuration.

enable

boolean

Indicates whether intelligent managed mode is enabled.

true

node_components

array<object>

The list of node components.

array<object>

The node component.

name

string

The node component name.

kubelet

version

string

The node component version.

1.33.3-aliyun.1

config

object

The node component configuration.

custom_config

object

The custom node component configuration.

{"cpuManagerPolicy":"static"}

any

The custom node component configuration string.

cpuManagerPolicy

config_revision

string

1

eflo_node_group

object

The Lingjun node group information.

cluster_id

string

The Lingjun cluster ID.

i113790071760688002461

group_id

string

The Lingjun group ID.

i128147721760688002463

auto_attach_enabled

boolean

worker_ram_role_name

string

成功レスポンス

JSONJSON

{
  "nodepools": [
    {
      "nodepool_info": {
        "nodepool_id": "np615c0e0966124216a0412e10afe0****",
        "name": "default-nodepool",
        "type": "ess",
        "is_default": true,
        "resource_group_id": "rg-acfmyvw3wjm****",
        "region_id": "cn-beijing",
        "created": "2025-04-15T16:33:29.362888807+08:00",
        "updated": "2025-04-15T16:33:32.823+08:00"
      },
      "status": {
        "state": "active",
        "healthy_nodes": 3,
        "initial_nodes": 0,
        "failed_nodes": 0,
        "offline_nodes": 0,
        "removing_nodes": 0,
        "serving_nodes": 3,
        "total_nodes": 3
      },
      "auto_scaling": {
        "enable": true,
        "type": "cpu",
        "max_instances": 10,
        "min_instances": 2,
        "eip_internet_charge_type": "PayByBandwidth",
        "is_bond_eip": true,
        "eip_bandwidth": 5
      },
      "management": {
        "enable": true,
        "auto_repair": true,
        "auto_repair_policy": {
          "restart_node": true,
          "approval_required": false,
          "auto_repair_policy_id": "r-xxxxxxxxx"
        },
        "auto_vul_fix": true,
        "auto_vul_fix_policy": {
          "restart_node": true,
          "vul_level": "asap,nntf",
          "exclude_packages": "kernel"
        },
        "auto_upgrade": true,
        "auto_upgrade_policy": {
          "auto_upgrade_kubelet": true
        },
        "upgrade_config": {
          "auto_upgrade": true,
          "surge": 5,
          "surge_percentage": 50,
          "max_unavailable": 1
        },
        "auto_fault_diagnosis": false
      },
      "scaling_group": {
        "scaling_group_id": "asg-2ze8n5qw4atggut8****",
        "vswitch_ids": [
          "vsw-2ze3ds0mdip0hdz8i****"
        ],
        "instance_types": [
          "ecs.n4.large"
        ],
        "instance_charge_type": "PostPaid",
        "period": 1,
        "period_unit": "Month",
        "auto_renew": false,
        "auto_renew_period": 0,
        "spot_strategy": "NoSpot",
        "spot_price_limit": [
          {
            "instance_type": "ecs.c6.large",
            "price_limit": "0.39"
          }
        ],
        "image_type": "AliyunLinux3",
        "image_id": "aliyun_3_x64_20G_alibase_20241218.vhd",
        "system_disk_category": "cloud_efficiency",
        "system_disk_categories": [
          "EESSD云盘"
        ],
        "system_disk_size": 120,
        "system_disk_performance_level": "PL1",
        "system_disk_encrypted": false,
        "system_disk_kms_key_id": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "system_disk_encrypt_algorithm": "aes-256",
        "system_disk_bursting_enabled": true,
        "system_disk_provisioned_iops": 1000,
        "data_disks": [
          {
            "category": "cloud_ssd",
            "size": 40,
            "encrypted": "true",
            "kms_key_id": "0e478b7a-4262-4802-b8cb-00d3fb40****",
            "auto_snapshot_policy_id": "sp-2zej1nogjvovnz4z****",
            "performance_level": "PL1",
            "provisioned_iops": 1000,
            "bursting_enabled": true,
            "auto_format": true,
            "file_system": "ext4",
            "mount_target": "/mnt/path1",
            "disk_name": "DataDiskName",
            "device": "/dev/xvdb",
            "snapshot_id": "s-280s7****"
          }
        ],
        "disk_init": [
          {
            "disk_name": "disk0",
            "mkfs_type": "ext4",
            "mount_target": "/mnt/disk0",
            "mount_for_runtime": false,
            "local_disk": false
          }
        ],
        "security_group_ids": [
          "sg-2ze1iuk12m2sb4c4****"
        ],
        "key_pair": "pro-nodepool",
        "login_password": "******",
        "login_as_non_root": true,
        "cis_enabled": false,
        "soc_enabled": false,
        "security_hardening_os": false,
        "internet_charge_type": "PayByBandwidth",
        "internet_max_bandwidth_out": 10,
        "tags": [
          {
            "key": "env",
            "value": "prod"
          }
        ],
        "desired_size": 2,
        "multi_az_policy": "COST_OPTIMIZED",
        "scaling_policy": "release",
        "on_demand_base_capacity": 0,
        "on_demand_percentage_above_base_capacity": 20,
        "spot_instance_pools": 5,
        "spot_instance_remedy": false,
        "compensate_with_on_demand": true,
        "deploymentset_id": "ds-bp1d19mmbsv3jf6xxxxx",
        "rds_instances": [
          "rm-xxx"
        ],
        "private_pool_options": {
          "id": "eap-bp67acfmxazb4****",
          "match_criteria": "Open"
        },
        "security_group_id": "sg-2ze1iuk12m2sb4c4****",
        "platform": "AliyunLinux",
        "ram_policy": "KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****",
        "instance_patterns": [
          {
            "cores": 4,
            "memory": 8,
            "instance_family_level": "EnterpriseLevel",
            "excluded_instance_types": [
              "ecs.c6.large"
            ],
            "min_cpu_cores": 4,
            "max_cpu_cores": 8,
            "min_memory_size": 8,
            "max_memory_size": 16,
            "instance_categories": [
              "General-purpose"
            ],
            "cpu_architectures": [
              "X86"
            ],
            "core": 4,
            "max_price": 2,
            "architectures": [
              "X86"
            ],
            "burst_performance_option": "Exclude",
            "instance_type_families": [
              "ecs.c6"
            ],
            "minimum_eni_quantity": 3,
            "minimum_eni_private_ip_address_quantity": 10,
            "minimum_eni_ipv6_address_quantity": 1,
            "maximum_gpu_amount": 8
          }
        ],
        "ram_role_name": "KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****",
        "resource_pool_options": {
          "strategy": "PrivatePoolFirst",
          "private_pool_ids": [
            "eap-bp1c1fohub5jccwi****"
          ]
        },
        "system_disk_snapshot_policy_id": "sp-0jl6xnmme8v7o935****"
      },
      "node_config": {
        "kubelet_configuration": {
          "registryPullQPS": 5,
          "registryBurst": 10,
          "eventRecordQPS": 5,
          "eventBurst": 10,
          "kubeAPIQPS": 5,
          "kubeAPIBurst": 10,
          "serializeImagePulls": true,
          "cpuManagerPolicy": "none",
          "evictionHard": {
            "test": "test",
            "test2": 1
          },
          "evictionSoft": {
            "test": "test",
            "test2": 1
          },
          "evictionSoftGracePeriod": {
            "test": "test",
            "test2": 1
          },
          "systemReserved": {
            "test": "test",
            "test2": 1
          },
          "kubeReserved": {
            "test": "test",
            "test2": 1
          },
          "readOnlyPort": 0,
          "maxPods": 110,
          "containerLogMaxSize": "10Mi",
          "containerLogMaxFiles": 5,
          "featureGates": {
            "test": "test",
            "test2": 1
          },
          "allowedUnsafeSysctls": [
            "net.core.somaxconn"
          ],
          "reservedMemory": [
            {
              "numaNode": 0,
              "limits": {
                "memory": "1Gi"
              }
            }
          ],
          "memoryManagerPolicy": "none",
          "cpuCFSQuota": true,
          "cpuCFSQuotaPeriod": "100ms",
          "imageGCHighThresholdPercent": 85,
          "imageGCLowThresholdPercent": 80,
          "podPidsLimit": -1,
          "topologyManagerPolicy": "restricted",
          "clusterDNS": [
            "127.0.xx.xx"
          ],
          "tracing": {
            "endpoint": "localhost:4317",
            "samplingRatePerMillion": 200000
          },
          "containerLogMaxWorkers": 1,
          "containerLogMonitorInterval": "10s",
          "serverTLSBootstrap": true
        },
        "node_os_config": {
          "hugepage": {
            "transparentEnabled": "",
            "transparentDefrag": "",
            "khugepagedDefrag": 0,
            "khugepagedAllocSleepMillisecs": 0,
            "khugepagedScanSleepMillisecs": 0,
            "khugepagedPagesToScan": 0
          }
        }
      },
      "kubernetes_config": {
        "labels": [
          {
            "key": "env",
            "value": "prod"
          }
        ],
        "taints": [
          {
            "key": "key",
            "value": "value",
            "effect": "NoSchedule"
          }
        ],
        "runtime": "containerd",
        "runtime_version": "1.6.38",
        "cpu_policy": "none",
        "user_data": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****",
        "unschedulable": true,
        "cms_enabled": true,
        "node_name_mode": "aliyun.com192.XX.YY.55test",
        "pre_user_data": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD"
      },
      "tee_config": {
        "tee_enable": false
      },
      "interconnect_config": {
        "cen_id": "cen-ey9k9nfhz0f*******",
        "ccn_id": "ccn-qm5i0i0q9yi*******",
        "ccn_region_id": "cn-shanghai",
        "bandwidth": 10,
        "improved_period": "1"
      },
      "max_nodes": 10,
      "interconnect_mode": "basic",
      "auto_mode": {
        "enable": true
      },
      "node_components": [
        {
          "name": "kubelet",
          "version": "1.33.3-aliyun.1",
          "config": {
            "custom_config": {
              "key": "cpuManagerPolicy"
            }
          },
          "config_revision": "1"
        }
      ],
      "eflo_node_group": {
        "cluster_id": "i113790071760688002461",
        "group_id": "i128147721760688002463",
        "auto_attach_enabled": false,
        "worker_ram_role_name": ""
      }
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。