DescribeClusterNodePoolDetail - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

ノードプール ID を指定して、クラスター内の指定されたノードプールの構成を照会します。

今すぐお試しください

この 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:DescribeClusterNodePoolDetail

get

*Cluster

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスターの ID。	c23421cfa74454bc8b37163fd19af****
NodepoolId	string	必須	ノードプールの ID。	np31da1b38983f4511b490fc62108a****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	ノードプールの詳細。
nodepool_info	object	ノードプールの構成。
nodepool_id	string	ノードプールの ID。	np615c0e0966124216a0412e10afe0****
name	string	ノードプールの名前。	デフォルト-nodepool
type	string	ノードプールのタイプ。有効な値: `ess`: 標準ノードプール (マネージドおよび弾力的スケーリングの特徴を含む)。 `edge`: エッジノードプール。 `lingjun`: Lingjun ノードプール。	ess。
is_default	boolean	これがデフォルトのノードプールであるかどうかを示します。通常、クラスターにはデフォルトのノードプールが 1 つだけ存在します。有効な値: `true`: これがデフォルトのノードプールです。 `false`: これはデフォルトのノードプールではありません。	true。
resource_group_id	string	リソースグループの ID。	rg-acfmyvw3wjmb****
region_id	string	リージョン ID。	cn-beijing。
created	string	ノードプールが作成された時間。	2025-04-10T14:25:37.285530433+08:00
updated	string	ノードプールが最後に更新された時間。	2025-04-15T15:39:45.41+08:00
status	object	ノードプールのステータス。
state	string	ノードプールのステータス。有効な値: `active`: ノードプールはアクティブな状態です。 `scaling`: ノードプールはスケーリング中です。 `removing`: ノードが削除されています。 `deleting`: ノードプールが削除されています。 `updating`: ノードプールが更新されています。	アクティブな
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
conditions	array<object>	ノードプールの条件。異なる次元におけるノードプールのステータス情報を表します。
	object	単一条件の属性。
type	string	タイプ。	ImageUpgradeReady
status	string	ステータス。	True
reason	string	理由。	UpgradeDisabled
message	string	詳細なメッセージ。	AutoUpgradeDisabled
last_transition_time	string	最後のステータストランジションの時間。	20--30T10:39:00+08:00
auto_scaling	object	ノードプールの auto scaling 構成。
enable	boolean	auto scaling が有効かどうかを指定します。有効な値: `true`: ノードプールの auto scaling 特徴を有効にします。クラスターの容量計画がアプリケーション Pod のスケジューリング要件を満たせない場合、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	既存のインスタンスを除く、ノードプールでスケーリング可能なインスタンスの最小値。	1
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-xxxxxxxxxx
max_parallel_repairing_nodes	string		1
max_unhealthy_nodes_threshold	string		10%
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
drift_enabled	boolean
scaling_group	object	ノードプールのスケーリンググループ構成。
scaling_group_id	string	スケーリンググループの ID。	asg-2zeieod8giqmov7z****
vswitch_ids	array	vSwitch ID のリスト。
	string	vSwitch の ID。	vsw-2ze3ds0mdip0hdz8i****
instance_types	array	ノードのインスタンスタイプのリスト。
	string	ノードのインスタンスタイプ。	ecs.n4.large。
instance_charge_type	string	ノードプール内のノードの課金タイプ。有効な値: `PrePaid`: サブスクリプション。 `PostPaid`: 従量課金。	PostPaid。
period	integer	インスタンスのサブスクリプション期間。このパラメーターは、`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}。	0
period_unit	string	サブスクリプション期間の単位。このパラメーターは、`instance_charge_type` が `PrePaid` に設定されている場合に指定する必要があります。有効な値: `Month`: 期間の課金単位としての月。 `Week`: 期間の課金単位としての週。	Month。
auto_renew	boolean	インスタンスの自動更新が有効かどうかを指定します。このパラメーターは、`instance_charge_type` が `PrePaid` に設定されている場合にのみ効果があります。有効な値: `true`: 自動更新を有効にします。 `false`: 自動更新を無効にします。	false。
auto_renew_period	integer	各自動更新サイクルの持続時間。有効な値: PeriodUnit=Week の場合: 1、2、3。 PeriodUnit=Month の場合: 1、2、3、6、12、24、36、48、60。	1
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。	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 クラウドディスク。	cloud_essd。
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	ノードシステムクラウドディスクでバースト (パフォーマンスバースト) が有効かどうかを指定します。有効な値: true: 有効。有効にすると、ワークロードの変動による突然のデータ読み取り/書き込み圧力の際に、クラウドディスクが一時的にパフォーマンスを向上させ、ワークロードが安定するまで維持します。 false: 無効。このパラメーターは、`system_disk_category` が `cloud_auto` に設定されている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」を参照してください。	true。
system_disk_provisioned_iops	integer	ノードシステムクラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。有効な値: 0~min{50,000, 1000capacity-baseline performance}。ベースラインパフォーマンス=min{1,800+50capacity, 50000}。このパラメーターは、`system_disk_category` が `cloud_auto` に設定されている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」を参照してください。	1000
data_disks	array	ノード用のデータクラウドディスクのディスクタイプ、サイズ、およびその他の構成の組み合わせ。
	data_disk	ノードのデータクラウドディスク構成。
security_group_ids	array	ノードプールのセキュリティグループ ID のリスト。
	string	ノードプールのセキュリティグループ ID。	sg-2ze60ockeekspl3d****
key_pair	string	キーペア名。このパラメーターまたは `login_password` のいずれかを指定します。マネージドノードプールでは、`key_pair` のみがサポートされています。	pro-ノードプール
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 セキュリティ強化が有効かどうかを指定します。この特徴。	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	ノードパブリック IP アドレスの最大アウトバウンド帯域幅 (Mbit/s 単位)。有効な値: 1〜100。	10
tags	array	ECS インスタンスタグ。
	tag	ノードタグ。
desired_size	integer	ノードプールの希望ノード数。	2
multi_az_policy	string	スケーリンググループ内の ECS インスタンスのマルチゾーンスケーリングポリシー。有効な値: `P	BALANCE。
scaling_policy	string	スケーリンググループモード。有効な値: `release`: 標準モード。リソース使用量に基づいて ECS インスタンスを作成およびリリースすることでスケーリングします。 `recycle`: 高速モード。インスタンスの作成、停止、開始によってスケーリングし、後続のスケーリング操作を高速化します。停止されたインスタンスにはストレージのみの料金が発生し、コンピューティングリソースの料金は発生しません。これはローカルディスクインスタンスタイプには適用されません。	release
on_demand_base_capacity	integer	The minimum number of pay-as-you-go instances required in the scaling group. Valid values: [0,1000]. Pay-as-you-go instances are created first when the number of pay-as-you-go instances is less than this value.	0
on_demand_percentage_above_base_capacity	integer	The percentage of pay-as-you-go instances among the excess instances after the minimum number of pay-as-you-go instances (`on_demand_base_capacity`) is met. Valid values: [0,100].	20
spot_instance_pools	integer	The number of available instance types. The scaling group creates spot instances across multiple types with the lowest cost. 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`: Enables spot instance supplementation. `false`: Disables 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 `multi_az_policy` is set to `COST_OPTIMIZED` and spot instances cannot be created due to price or inventory reasons. 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 an RDS instance list is specified, ECS instances in the cluster node pool are automatically added to the RDS access whitelist.
	string	The RDS instance.	rm-xxx
private_pool_options	object	The private node pool configuration.
id	string	The private node pool ID.	eap-bp67acfmxazb4****
match_criteria	string	The private node pool type. The private pool capacity option for instance launch. After an elasticity assurance or capacity reservation takes effect, a private pool capacity is generated for instance launch. Valid values: `Open`: open mode. Automatically matches open-type private pool capacity. If no matching private pool capacity is available, public pool resources are used. `Target`: specified mode. Uses the specified private pool capacity to launch instances. If the private pool capacity is unavailable, the instance fails to launch. `None`: not used mode. Instance launch does not use private pool capacity.	Open
security_group_id	string	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-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 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****
instance_metadata_options	InstanceMetadataOptions	The metadata access configuration for ECS instances.
resource_pool_options	object	The resource pool and resource pool strategy 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 strategy used when creating instances. Valid values: PrivatePoolFirst: private pool first. PrivatePoolOnly: private pool only. None: no resource pool strategy.	PrivatePoolFirst
system_disk_snapshot_policy_id	string	The system cloud disk snapshot policy.	sp-bp11g8z59rawcud9****
disk_init	array	The block device initialization configuration.
	DiskInit	The DiskInit configuration.
cpu_options	object
nested_virtualization	string		enabled
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 ECS tag.
taints	array	The node taint information. Taints and tolerations work together to prevent pods from being scheduled 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 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 cluster versions 1.12.6 and later: `static`: Allows pods with certain resource characteristics on the node to be granted enhanced CPU affinity and exclusivity. `none`: Enables 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.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi
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 option. 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: Both the prefix and suffix can 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 node pool pre-custom data, which is a script that runs before node initialization. For more information, see Generate instance user data.	dGhpcyBpcyBhIGV4YW1wbGU
tee_config	object	The confidential computing cluster configuration.
tee_enable	boolean	Specifies whether to enable the confidential computing 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	[This field is deprecated] The Cloud Enterprise Network (CEN) instance ID bound to the edge enhanced node pool.	cen-ey9k9nfhz0f*******
ccn_id	string	[This field is deprecated] The Cloud Connect Network (CCN) instance ID bound to the edge enhanced node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[This field is deprecated] The region of the Cloud Connect Network instance bound to the edge enhanced node pool.	cn-shanghai
bandwidth	integer	[This field is deprecated] The network bandwidth of the edge enhanced node pool, in Mbps.	10
improved_period	string	[This field is deprecated] The subscription duration of the edge enhanced node pool, in months.	1
max_nodes	integer	[This field is deprecated] The maximum number of nodes allowed in the edge node pool.	10
interconnect_mode	string	The network type of the edge node pool. This parameter takes effect only for node pools with `type` set to `edge`. Valid values: `basic`: Public network. Nodes cloud node pool interact with cloud nodes over the Internet. Applications in the node pool cannot directly access the cloud VPC internal network. `private`: Private network. Nodes cloud node pool connect to the cloud through Express Connect, VPN, or CEN, providing higher cloud-edge communication quality and more effective security.	basic
host_network	boolean	Specifies whether the pod network uses host network mode. `true`: Host network. Pods directly use the host network stack and share the IP address and ports with the host. `false`: Container network. Pods have independent network stacks and do not occupy host network ports.	true。
intranet	boolean	Specifies whether nodes within the edge node pool have Layer 3 network connectivity. `true`: Connected. All nodes in the node pool have Layer 3 network connectivity. `false`: Not connected. All nodes in the node pool do not have Layer 3 network connectivity.	true。
auto_mode	object	The intelligent managed configuration.
enable	boolean	Specifies whether to enable this feature.	false。
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 node component custom configuration.	{"cpuManagerPolicy":"static"}
	any	The node component custom configuration string.	cpuManagerPolicy
config_revision	string		1
eflo_node_group	object
cluster_id	string		i113790071760688002461
group_id	string		i128147721760688002463
auto_attach_enabled	boolean
worker_ram_role_name	string

例

成功レスポンス

JSONJSON

{
  "nodepool_info": {
    "nodepool_id": "np615c0e0966124216a0412e10afe0****",
    "name": "default-nodepool",
    "type": "ess",
    "is_default": true,
    "resource_group_id": "rg-acfmyvw3wjmb****",
    "region_id": "cn-beijing",
    "created": "2025-04-10T14:25:37.285530433+08:00",
    "updated": "2025-04-15T15:39:45.41+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,
    "conditions": [
      {
        "type": "ImageUpgradeReady",
        "status": "True",
        "reason": "UpgradeDisabled",
        "message": "AutoUpgradeDisabled",
        "last_transition_time": "20**-**-30T10:39:00+08:00"
      }
    ]
  },
  "auto_scaling": {
    "enable": true,
    "type": "cpu",
    "max_instances": 10,
    "min_instances": 1,
    "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-xxxxxxxxxx",
      "max_parallel_repairing_nodes": "1",
      "max_unhealthy_nodes_threshold": "10%"
    },
    "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,
    "drift_enabled": false
  },
  "scaling_group": {
    "scaling_group_id": "asg-2zeieod8giqmov7z****",
    "vswitch_ids": [
      "vsw-2ze3ds0mdip0hdz8i****"
    ],
    "instance_types": [
      "ecs.n4.large"
    ],
    "instance_charge_type": "PostPaid",
    "period": 0,
    "period_unit": "Month",
    "auto_renew": false,
    "auto_renew_period": 1,
    "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": [
      "cloud_essd"
    ],
    "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****"
      }
    ],
    "security_group_ids": [
      "sg-2ze60ockeekspl3d****"
    ],
    "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": "BALANCE",
    "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-2ze60ockeekspl3d****",
    "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****",
    "instance_metadata_options": {
      "http_tokens": "optional"
    },
    "resource_pool_options": {
      "private_pool_ids": [
        "eap-bp1c1fohub5jccwi****"
      ],
      "strategy": "PrivatePoolFirst"
    },
    "system_disk_snapshot_policy_id": "sp-bp11g8z59rawcud9****",
    "disk_init": [
      {
        "disk_name": "disk0",
        "mkfs_type": "ext4",
        "mount_target": "/mnt/disk0",
        "mount_for_runtime": false,
        "local_disk": false
      }
    ],
    "cpu_options": {
      "nested_virtualization": "enabled"
    }
  },
  "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": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi",
    "unschedulable": true,
    "cms_enabled": true,
    "node_name_mode": "aliyun.com192.XX.YY.55test",
    "pre_user_data": "dGhpcyBpcyBhIGV4YW1wbGU\n"
  },
  "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",
  "host_network": true,
  "intranet": true,
  "auto_mode": {
    "enable": false
  },
  "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": ""
  }
}

エラーコード

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

変更履歴

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