ノードプール ID を指定して、クラスター内の指定されたノードプールの構成を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:DescribeClusterNodePoolDetail |
get |
*Cluster
|
なし | なし |
リクエスト構文
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 |
ノードプール名。 |
default-nodepool |
| type |
string |
ノードプールのタイプ。有効な値:
|
ess |
| is_default |
boolean |
ノードプールがデフォルトノードプールかどうかを示します。クラスターには通常、デフォルトノードプールが 1 つだけあります。有効な値:
|
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 |
| 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 を有効にするかどうかを指定します。有効な値:
このパラメーターが false に設定されている場合、 |
true |
| type |
string |
インスタンスタイプ別に分類された auto scaling タイプ。有効な値:
|
cpu |
| max_instances |
integer |
ノードプールでスケーリングできるインスタンスの最大値(既存のインスタンスを除く)。 |
10 |
| min_instances |
integer |
ノードプールでスケーリングできるインスタンスの最小値(既存のインスタンスを除く)。 |
1 |
| 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-xxxxxxxxxx |
| 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 |
追加ノードの数。このパラメーターまたは surge_percentage を設定できます。 |
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-2zeieod8giqmov7z**** |
| vswitch_ids |
array |
vSwitch ID のリスト。 |
|
|
string |
vSwitch ID。 |
vsw-2ze3ds0mdip0hdz8i**** |
|
| instance_types |
array |
ノードインスタンスタイプのリスト。 |
|
|
string |
ノードインスタンスタイプ。 |
ecs.n4.large |
|
| instance_charge_type |
string |
ノードプール内のノードの課金方法。有効な値:
|
PostPaid |
| period |
integer |
ノードのサブスクリプション期間。このパラメーターは
|
0 |
| period_unit |
string |
ノードの課金サイクル。
|
Month |
| auto_renew |
boolean |
ノードの自動更新を有効にするかどうかを指定します。このパラメーターは
|
false |
| auto_renew_period |
integer |
1 回の自動更新サイクルの持続時間。有効な値:
|
1 |
| 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 |
ノードのシステムクラウドディスクタイプ。 有効な値:
|
cloud_essd |
|
| 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。 有効な値: 0 ~ min{50,000, 1000 × 容量 - ベースラインパフォーマンス}。ベースラインパフォーマンス = min{1,800 + 50 × 容量, 50000}。 このパラメーターは |
1000 |
| data_disks |
array |
データクラウドディスクの構成(ディスクタイプとサイズを含む)。 |
|
| data_disk |
ノードのデータクラウドディスク構成。 |
||
| security_group_ids |
array |
ノードプールのセキュリティグループ ID のリスト。 |
|
|
string |
ノードプールのセキュリティグループ ID。 |
sg-2ze60ockeekspl3d**** |
|
| key_pair |
string |
キーペア名。このパラメーターまたは |
pro-nodepool |
| login_password |
string |
SSH ログインパスワード。このパラメーターまたは セキュリティ上の理由から、クエリ結果ではパスワードは暗号化されます。 |
******** |
| login_as_non_root |
boolean |
スケールアウトされた ECS インスタンスが非ルートユーザーでログインするかどうかを指定します。
|
true |
cis_enabled
deprecated
|
boolean |
[このフィールドは非推奨です] 代わりに security_hardening_os パラメーターを使用してください。セキュリティ強化に関する設定です。 |
false |
| soc_enabled |
boolean |
等級保護 2.0 セキュリティ強化を有効にするかどうかを指定します。システムイメージが Alibaba Cloud Linux 2 または Alibaba Cloud Linux 3 の場合にのみ、ノードの等級保護 2.0 セキュリティ強化を有効にできます。Alibaba Cloud は、Alibaba Cloud Linux 2 および Alibaba Cloud Linux 3 等級保護 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 |
ノードタグ。 |
||
| desired_size |
integer |
ノードプール内の希望ノード数。 |
2 |
| multi_az_policy |
string |
スケーリンググループ内の ECS インスタンスのマルチゾーンスケーリングポリシー。有効な値:
デフォルト値: |
BALANCE |
| scaling_policy |
string |
スケーリンググループモード。有効な値:
|
release |
| on_demand_base_capacity |
integer |
The minimum number of pay-as-you-go instances required in 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 created first. |
0 |
| on_demand_percentage_above_base_capacity |
integer |
The percentage of pay-as-you-go instances among the instances that exceed the minimum pay-as-you-go instance count ( |
20 |
| spot_instance_pools |
integer |
The number of available instance types. The scaling group creates spot instances across multiple types with the lowest cost in a balanced manner. Valid values: [1,10]. |
5 |
| spot_instance_remedy |
boolean |
Specifies whether to enable supplemental spot instances. When enabled, the scaling group attempts to create new instances to replace spot instances that are about to be reclaimed. Valid values:
|
false |
| compensate_with_on_demand |
boolean |
Specifies whether to automatically create pay-as-you-go instances when spot instances cannot be created due to price or inventory reasons. This parameter takes effect only when
|
true |
| deploymentset_id |
string |
The deployment set ID. |
ds-bp1d19mmbsv3jf6xxxxx |
| rds_instances |
array |
The list of RDS instances. If specified, the ECS instances of cluster nodes are automatically added to the RDS access whitelist. |
|
|
string |
The RDS instance. |
rm-xxx |
|
| private_pool_options |
object |
The private pool configuration. |
|
| id |
string |
The private pool ID. |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
The private pool type, which specifies the 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 |
| 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 |
sg-2ze60ockeekspl3d**** |
| platform |
string |
The operating system distribution. Valid values:
|
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 policy used for instance creation. |
|
| private_pool_ids |
array |
The list of private pool IDs. |
|
|
string |
The private pool ID. |
eap-bp1c1fohub5jccwi**** |
|
| 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 |
| system_disk_snapshot_policy_id |
string |
The snapshot policy for the system cloud disk. |
sp-bp11g8z59rawcud9**** |
| disk_init |
array |
The block device initialization configuration. |
|
|
DiskInit |
The DiskInit configuration. |
||
| 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 |
| runtime_version |
string |
The container runtime version. |
1.6.38 |
| cpu_policy |
string |
The CPU management policy for nodes. The following two policies are supported for clusters of version 1.12.6 and later:
|
none |
| user_data |
string |
The custom data of the node pool, 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 |
| 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 |
| node_name_mode |
string |
The custom node name. A node name consists of three parts: prefix + node IP address substring + suffix:
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 pre-initialization custom data of the node pool, 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:
|
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 enhanced edge node pool. |
cen-ey9k9nfhz0f******* |
| ccn_id |
string |
[This field is deprecated] The Cloud Connect Network (CCN) instance ID bound to the enhanced edge node pool. |
ccn-qm5i0i0q9yi******* |
| ccn_region_id |
string |
[This field is deprecated] The region of the Cloud Connect Network (CCN) instance bound to the enhanced edge node pool. [. |
cn-shanghai |
| bandwidth |
integer |
[This field is deprecated] The network bandwidth of the edge-enhanced node pool. Unit: Mbit/s. |
10 |
| improved_period |
string |
[This field is deprecated] The subscription duration of the edge-enhanced node pool. Unit: months. |
1 |
| max_nodes |
integer |
[This field is deprecated] The maximum number of nodes that the edge node pool can contain. |
10 |
| interconnect_mode |
string |
The network type of the edge node pool. This parameter takes effect only for node pools whose
|
basic |
| host_network |
boolean |
Specifies whether the pod network uses host network mode.
|
true |
| intranet |
boolean |
Specifies whether Layer 3 network connectivity is enabled among nodes in the edge node pool.
|
true |
| auto_mode |
object |
The intelligent managed configuration. |
|
| enable |
boolean |
Specifies whether to enable the feature. |
false |
| node_components |
array<object> |
The list of node components. |
|
|
array<object> |
The node component. |
||
| name |
string |
The name of the node component. |
kubelet |
| version |
string |
The version of the node component. |
1.33.3-aliyun.1 |
| config |
object |
The configuration of the node component. |
|
| custom_config |
object |
The custom configuration of the node component. |
{"cpuManagerPolicy":"static"} |
|
any |
节点组件自定义配置字符串。 |
cpuManagerPolicy |
|
| eflo_node_group |
object |
||
| cluster_id |
string |
i113790071760688002461 |
|
| group_id |
string |
i128147721760688002463 |
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。