クラスター内のすべてのノードプールのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:DescribeClusterNodePools |
get |
*Cluster
|
なし | なし |
リクエスト構文
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 |
| is_default |
boolean |
ノードプールがデフォルトノードプールかどうかを示します。クラスターには通常、デフォルトノードプールが1つだけ存在します。有効な値:
|
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 |
| 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 |
オートスケーリング設定。 |
|
| enable |
boolean |
オートスケーリングを有効にするかどうかを指定します。有効な値:
このパラメーターがfalseに設定されている場合、 |
true |
| type |
string |
インスタンスタイプ別のオートスケーリングタイプ。有効な値:
|
cpu |
| max_instances |
integer |
ノードプールでスケーリングできるインスタンスの最大数(既存のインスタンスを除く)。 |
10 |
| min_instances |
integer |
ノードプールでスケーリングできるインスタンスの最小数(既存のインスタンスを除く)。 |
2 |
| eip_internet_charge_type |
string |
EIPの課金方式。有効な値:
|
PayByBandwidth |
| is_bond_eip |
boolean |
EIPを関連付けるかどうかを指定します。有効な値:
|
true |
| eip_bandwidth |
integer |
EIPのピーク帯域幅。 有効な値: [1,100]。単位: Mbit/s。 |
5 |
| management |
object |
マネージドノードプール設定。現在、プロフェッショナルマネージドクラスターでのみ有効です。 |
|
| enable |
boolean |
マネージドノードプールを有効にするかどうかを指定します。有効な値:
|
true |
| auto_repair |
boolean |
自動修復を有効にするかどうかを指定します。このパラメーターは
|
true |
| auto_repair_policy |
object |
ノードの自動修復ポリシー。 |
|
| restart_node |
boolean |
ノードの再起動を許可するかどうかを指定します。このパラメーターは
|
true |
| approval_required |
boolean |
ノード修復に手動承認が必要かどうかを指定します。 |
false |
| auto_repair_policy_id |
string |
自動修復ポリシーのID。 |
r-xxxxxxxxx |
| auto_vul_fix |
boolean |
CVE 自動修正を有効にするかどうかを指定します。このパラメーターは
|
true |
| auto_vul_fix_policy |
object |
CVE 自動修正ポリシー。 |
|
| restart_node |
boolean |
ノードの再起動を許可するかどうかを指定します。このパラメーターは
|
true |
| vul_level |
string |
自動修正が許可される脆弱性レベル(カンマ区切り)。
|
asap,nntf |
| exclude_packages |
string |
脆弱性修正時に除外するパッケージ。 |
kernel |
| auto_upgrade |
boolean |
ノードの自動アップグレードを有効にするかどうかを指定します。このパラメーターは
|
true |
| auto_upgrade_policy |
object |
自動アップグレードポリシー。 |
|
| auto_upgrade_kubelet |
boolean |
kubeletの自動アップグレードを許可するかどうかを指定します。このパラメーターは
|
true |
| upgrade_config |
object |
自動アップグレード設定。このパラメーターは |
|
| auto_upgrade |
boolean |
自動アップグレードを有効にするかどうかを指定します。有効な値:
|
true |
| surge |
integer |
追加ノード数。このパラメーターまたは |
5 |
| surge_percentage |
integer |
追加ノードの割合。このパラメーターまたは 追加ノード数 = 追加ノードの割合 × ノード数。例えば、追加ノードの割合が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 |
ノードプール内のノードの課金方式。有効な値:
|
PostPaid |
| period |
integer |
ノードのサブスクリプション期間。このパラメーターは
|
1 |
| period_unit |
string |
ノードの課金サイクル単位。このパラメーターは
|
Month |
| auto_renew |
boolean |
ノードの自動更新を有効にするかどうかを指定します。このパラメーターは
|
false |
| auto_renew_period |
integer |
各自動更新サイクルの期間。有効な値:
|
0 |
| spot_strategy |
string |
スポットインスタンスタイプ。有効な値:
詳細については、スポットインスタンスをご参照ください。 |
NoSpot |
| spot_price_limit |
array<object> |
スポットインスタンスの価格範囲設定。 |
|
|
object |
スポットインスタンスの価格範囲設定。インスタンスタイプごとに異なる価格範囲を設定できます。 |
||
| instance_type |
string |
スポットインスタンスタイプ。 |
ecs.c6.large |
| price_limit |
string |
単一インスタンスの価格上限。 単位: 米ドル/時間。 |
0.39 |
| image_type |
string |
OSイメージタイプ。有効な値:
|
AliyunLinux3 |
| image_id |
string |
カスタムイメージID。 |
aliyun_3_x64_20G_alibase_20241218.vhd |
| system_disk_category |
string |
ノードのシステムクラウドディスクタイプ。有効な値:
|
cloud_efficiency |
| system_disk_categories |
array |
システムクラウドディスクのマルチディスクタイプ。優先度の高いディスクタイプが利用できない場合、システムは自動的に次の優先度のディスクタイプを試行してシステムクラウドディスクを作成します。 |
|
|
string |
ノードのシステムクラウドディスクタイプ。 有効な値:
|
EESSD云盘 |
|
| system_disk_size |
integer |
ノードのシステムクラウドディスクのサイズ。単位: GiB。 有効な値: [20,2048]。 |
120 |
| system_disk_performance_level |
string |
システムクラウドディスクのパフォーマンスレベル。このパラメーターはESSDクラウドディスクの場合のみ有効です。パフォーマンスレベルはディスクサイズによって異なります。詳細については、 ESSD をご参照ください。標準 SSDはパフォーマンスレベルをサポートしていません。
|
PL1 |
| system_disk_encrypted |
boolean |
システムクラウドディスクを暗号化するかどうかを指定します。有効な値:
|
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 |
| 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 |
キーペア名。このパラメーターまたは マネージドノードプールでは、 |
pro-nodepool |
| login_password |
string |
SSHログインパスワード。このパラメーターまたは セキュリティ上の理由により、クエリ結果ではパスワードは暗号化されます。 |
****** |
| login_as_non_root |
boolean |
スケールアウトされたECSインスタンスが非 rootユーザーでログオンするかどうかを指定します。
|
true |
cis_enabled
deprecated
|
boolean |
[このフィールドは非推奨です] 代わりにsecurity_hardening_osパラメーターを使用してください。 |
false |
| soc_enabled |
boolean |
MLPS 2.0セキュリティハードニングを有効にするかどうかを指定します。このオプションは、システムイメージがAlibaba Cloud Linux 2またはAlibaba Cloud Linux 3の場合のみ利用可能です。Alibaba Cloudは、Alibaba Cloud Linux 2およびAlibaba Cloud Linux 3のMLPS 2.0レベル3イメージ向けに、等級保護コンプライアンスベースラインチェック基準とスキャンプログラムを提供しています。 |
false |
| security_hardening_os |
boolean |
Alibaba Cloud OSセキュリティハードニングを有効にするかどうかを指定します。有効な値:
デフォルト値: |
false |
| internet_charge_type |
string |
ノードのパブリックIPアドレスの課金方式。
|
PayByBandwidth |
| internet_max_bandwidth_out |
integer |
ノードのパブリックIPアドレスの最大アウトバウンド帯域幅。単位: Mbit/s。有効な値: 1~100。 |
10 |
| tags |
array |
ECSインスタンスタグ。 |
|
| tag |
ノードタグ。 |
[{\"key\":\"pkg.E2EClient.ClusterId\",\"value\":\"troopers-\"}] |
|
| desired_size |
integer |
ノードプールの期望ノード数。 |
2 |
| multi_az_policy |
string |
スケーリンググループ内のECSインスタンスのマルチゾーンスケーリングポリシー。有効な値:
|
COST_OPTIMIZED |
| scaling_policy |
string |
スケーリンググループモード。有効な値:
|
release |
| on_demand_base_capacity |
integer |
スケーリンググループに必要な従量課金インスタンスの最小数。有効な値: [0,1000]。従量課金インスタンスの数がこの値未満の場合、従量課金インスタンスが最初に作成されます。 |
0 |
| on_demand_percentage_above_base_capacity |
integer |
従量課金インスタンスの最小数( |
20 |
| spot_instance_pools |
integer |
利用可能なインスタンスタイプの数。スケーリンググループは最もコストの低いインスタンスタイプ間でスポットインスタンスをバランスよく作成します。有効な値: [1,10]。 |
5 |
| spot_instance_remedy |
boolean |
補充スポットインスタンスを有効にするかどうかを指定します。有効にすると、スケーリンググループは回収されようとしているスポットインスタンスの代わりに新しいインスタンスの作成を試みます。有効な値:
|
false |
| compensate_with_on_demand |
boolean |
コストや在庫の理由でスポットインスタンスを作成できない場合に、必要なECSインスタンス数を満たすために従量課金インスタンスの自動作成を許可するかどうかを指定します。このパラメーターは
|
true |
| deploymentset_id |
string |
デプロイメントセットID。 |
ds-bp1d19mmbsv3jf6xxxxx |
| rds_instances |
array |
RDSインスタンスのリスト。指定すると、クラスター内のECSインスタンスはRDSホワイトリストに自動的に追加されます。 |
|
|
string |
RDSインスタンス。 |
rm-xxx |
|
| private_pool_options |
object |
プライベートプールオプション。 |
|
| id |
string |
プライベートプールID。エラスティシティ保証 IDまたはキャパシティ予約 IDです。 |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
プライベートノードプールのタイプ。インスタンス起動用のプライベートプールキャパシティオプションを指定します。エラスティシティ保証またはキャパシティ予約が有効になると、インスタンス起動用のプライベートプールが生成されます。有効な値:
|
Open |
| security_group_id |
string |
[このフィールドは非推奨です] ノードプールのセキュリティグループID。ノードプールが複数のセキュリティグループに関連付けられている場合、これは |
sg-2ze1iuk12m2sb4c4**** |
| platform |
string |
[このフィールドは非推奨です] OSディストリビューション。有効な値:
|
AliyunLinux |
| ram_policy |
string |
このフィールドは非推奨です。代わりにram_role_nameを使用してください。 |
KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e**** |
| instance_patterns |
array |
インスタンス属性設定。 |
|
| instance_patterns |
インスタンス属性。 |
||
| ram_role_name |
string |
ワーカーRAMロール名。 |
KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f**** |
| resource_pool_options |
object |
インスタンス作成時に使用されるリソースプールとリソースプールポリシー。 |
|
| strategy |
string |
インスタンス作成時に使用されるリソースプールポリシー。有効な値: PrivatePoolFirst: プライベートプール優先。 PrivatePoolOnly: プライベートプールのみ。 None: リソースプールポリシーなし。 |
PrivatePoolFirst |
| private_pool_ids |
array |
プライベートプールIDのリスト。 |
|
|
string |
プライベートプールID。 |
eap-bp1c1fohub5jccwi**** |
|
| system_disk_snapshot_policy_id |
string |
システムクラウドディスクのスナップショットポリシー。 |
sp-0jl6xnmme8v7o935**** |
| node_config |
object |
ノード設定。 |
|
| kubelet_configuration | kubelet_config |
kubeletパラメーター設定。 |
|
| node_os_config |
object |
ノードOS 設定。 |
|
| hugepage |
Hugepage |
ヒュージページ設定。 |
|
| kubernetes_config |
object |
クラスター関連の設定。 |
|
| labels |
array |
ノードタグ。 |
|
| tag |
ラベル設定。 |
{} |
|
| taints |
array |
ノードのテイント情報。テイントとトレラレーションは連携して、ポッドが不適切なノードにスケジュールされることを防ぎます。詳細については、taint-and-tolerationをご参照ください。 |
|
| taint |
ノードのテイント情報。 |
||
| runtime |
string |
コンテナランタイム名。ACKは以下の3つのコンテナランタイムをサポートしています:
|
containerd |
| runtime_version |
string |
コンテナランタイムバージョン。 |
1.6.38 |
| cpu_policy |
string |
ノードのCPU 管理ポリシー。バージョン1.12.6 以降のクラスターでは、以下の2つのポリシーがサポートされています:
|
none |
| user_data |
string |
ノードプールのカスタムデータ。ノード初期化後に実行されるスクリプトです。詳細については、インスタンスのユーザーデータの生成をご参照ください。 |
IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD**** |
| unschedulable |
boolean |
スケールアウトされたノードがスケジュール不可かどうかを指定します。
|
true |
| cms_enabled |
boolean |
ECSノードにCloudMonitorエージェントをインストールするかどうかを指定します。インストール後、CloudMonitorコンソールで作成されたECSインスタンスの監視情報を確認できます。この機能を有効にすることをお勧めします。有効な値:
|
true |
| node_name_mode |
string |
カスタムノード名。 ノード名はプレフィックス + ノードIPアドレスの部分文字列 + サフィックスの3つの部分で構成されます:
例えば、ノードIPアドレスが192.168.0.55、プレフィックスがaliyun.com、IPアドレスセグメント長が5、サフィックスがtestの場合、ノード名はaliyun.com00055testになります。 |
aliyun.com192.XX.YY.55test |
| pre_user_data |
string |
ノードプールのプリカスタムデータ。ノード初期化前に実行されるスクリプトです。詳細については、インスタンスカスタムデータの生成をご参照ください。 |
IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD |
| tee_config |
object |
機密コンピューティング設定。 |
|
| tee_enable |
boolean |
TEEクラスターを有効にするかどうか。有効な値:
|
false |
| interconnect_config |
object |
[このフィールドは非推奨です] エッジノードプールのネットワーク関連設定。この値はエッジタイプのノードプールに対してのみ意味があります。 |
|
| cen_id |
string |
[非推奨] 拡張エッジノードプールにバインドされたCloud Enterprise Network(CEN)インスタンスID。 |
cen-ey9k9nfhz0f******* |
| ccn_id |
string |
[非推奨] 拡張エッジノードプールにバインドされたCloud Connect Network(CCN)インスタンスID。 |
ccn-qm5i0i0q9yi******* |
| ccn_region_id |
string |
[非推奨] 拡張エッジノードプールにバインドされたCloud Connect Network(CCN)インスタンスのリージョン。 |
cn-shanghai |
| bandwidth |
integer |
[非推奨] 拡張エッジノードプールのネットワーク帯域幅。単位: Mbit/s。 |
10 |
| improved_period |
string |
[非推奨] 拡張エッジノードプールのサブスクリプション期間。単位: 月。 |
1 |
| max_nodes |
integer |
エッジノードプールで許可されるノードの最大数。ノードプールが収容できるノードの最大数です。このパラメーターは0 以上である必要があります。0は追加の制限がないことを意味します(クラスター全体のノードキャパシティのみによって制限され、ノードプール自体に追加の制限はありません)。エッジノードプールでは通常この値は0より大きくなります。essタイプのノードプールおよびデフォルトエッジタイプのノードプールではこの値は0に設定されます。 |
10 |
| interconnect_mode |
string |
エッジノードプールのネットワークタイプ。このパラメーターは
|
basic |
| auto_mode |
object |
インテリジェントマネージド設定。 |
|
| enable |
boolean |
インテリジェントホスティングが有効かどうか。 |
true |
| node_components |
array<object> |
ノードコンポーネントリスト。 |
|
|
array<object> |
ノードコンポーネント。 |
||
| name |
string |
ノードコンポーネントの名前。 |
kubelet |
| version |
string |
ノードコンポーネントのバージョン。 |
1.33.3-aliyun.1 |
| config |
object |
ノードコンポーネントの設定。 |
|
| custom_config |
object |
ノードコンポーネントのカスタム設定。 |
{"cpuManagerPolicy":"static"} |
|
string |
ノードコンポーネントのカスタム設定文字列。 |
cpuManagerPolicy |
|
| eflo_node_group |
object |
Lingjunノードグループ情報。 |
|
| cluster_id |
string |
LingjunクラスターID。 |
i113790071760688002461 |
| group_id |
string |
LingjunグループID。 |
i128147721760688002463 |
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。