クラスター内のすべてのノードプールのリストを照会します。
今すぐお試しください
テスト
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 |
auto scaling の構成。 |
|
| 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 |
単一インスタンスの価格上限。 単位:USD/時間。。 |
0.39 |
| image_type |
string |
オペレーティングシステムのイメージタイプ。有効な値:
|
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 を参照してください。
|
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 |
[このフィールドは非推奨です] オペレーティングシステムのディストリビューション。有効な値:
|
AliyunLinux |
| ram_policy |
string |
このフィールドは非推奨です。代わりにram_role_nameを使用してください。 |
KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e**** |
| instance_patterns |
array |
インスタンス属性の設定。 |
|
| instance_patterns |
インスタンス属性。 |
||
| ram_role_name |
string |
Worker 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 |
ノードのオペレーティングシステム設定。 |
|
| hugepage |
Hugepage |
Hugepage 設定。 |
|
| kubernetes_config |
object |
クラスター関連の構成。 |
|
| labels |
array |
ノードタグ。 |
|
| tag |
ラベル設定。 |
{} |
|
| taints |
array |
ノードのTaint 情報。TaintとTolerationは連携して、Podが不適切なノードにスケジュールされることを防ぎます。詳細については、taint-and-tolerationを参照してください。 |
|
| taint |
ノードの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 |
クラスターの機密コンピューティングを有効にするかどうかを指定します。有効な値:
|
false |
| interconnect_config |
object |
[このフィールドは非推奨です] エッジノードプールのネットワーク設定。この値はedgeタイプのノードプールにのみ有効です。 |
|
| 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タイプのノードプールとデフォルトのedgeタイプのノードプールでは値は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"} |
|
any |
ノードコンポーネントのカスタム設定文字列。 |
cpuManagerPolicy |
|
| eflo_node_group |
object |
Lingjun ノードグループ情報。 [_single.resp.200.props.nodepools.items。 |
|
| cluster_id |
string |
LingjunクラスターID。 |
i113790071760688002461 |
| group_id |
string |
LingjunグループID。 |
i128147721760688002463 |
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。