ノードプール ID に基づいてノードプールの構成を更新します。
操作説明
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:ModifyClusterNodePool |
update |
*Cluster
|
なし | なし |
リクエスト構文
PUT /clusters/{ClusterId}/nodepools/{NodepoolId} HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClusterId |
string |
必須 |
クラスターの ID。 |
c23421cfa74454bc8b37163fd19af**** |
| NodepoolId |
string |
必須 |
ノードプールの ID。 |
p31da1b38983f4511b490fc62108a**** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディのパラメーター。 |
|
| nodepool_info |
object |
任意 |
ノードプールの構成。 |
|
| name |
string |
任意 |
ノードプールの名前。 命名規則: 名前は 1~63 文字で、数字、漢字、英字、ハイフン (-) を含めることができます。ハイフン (-) で始めることはできません。 |
default-nodepool |
| resource_group_id |
string |
任意 |
ノードプールのリソースグループの ID。ノードプールによって作成されたインスタンスは、このリソースグループに属します。 リソースは 1 つのリソースグループにのみ属することができます。ビジネスシナリオに基づいて、リソースグループをプロジェクト、アプリケーション、組織などの概念にマッピングできます。 |
rg-acfmyvw3wjm**** |
| auto_scaling |
object |
任意 |
auto scaling の構成。 |
|
| enable |
boolean |
任意 |
Auto scaling を有効にするかどうかを指定します。有効な値:
このパラメーターが false に設定されている場合、 デフォルト値: |
true |
type
deprecated
|
string |
任意 |
インスタンスタイプ別に分類された auto scaling タイプ。有効な値:
デフォルト値: |
cpu |
| max_instances |
integer |
任意 |
ノードプール内のスケーラブルなインスタンスの最大値 (既存のインスタンスを除く)。このパラメーターは 有効な値: [min_instances, 2000]。デフォルト値: 0。 |
10 |
| min_instances |
integer |
任意 |
ノードプール内のスケーラブルなインスタンスの最小値 (既存のインスタンスを除く)。このパラメーターは 有効な値: [0, max_instances]。デフォルト値: 0。 説明
|
2 |
is_bond_eip
deprecated
|
boolean |
任意 |
[このフィールドは非推奨です] このフィールドは非推奨です。代わりに internet_charge_type および internet_max_bandwidth_out を使用してください。
デフォルト値: |
null |
eip_internet_charge_type
deprecated
|
string |
任意 |
[このフィールドは非推奨です] 代わりに internet_charge_type および internet_max_bandwidth_out を使用してください。 EIP の課金タイプ。有効な値:
デフォルト値: |
null |
eip_bandwidth
deprecated
|
integer |
任意 |
[このフィールドは非推奨です] 代わりに internet_charge_type および internet_max_bandwidth_out を使用してください。 EIP のピーク帯域幅。 有効な値: [1,100]。単位: Mbit/s。 |
null |
| management |
object |
任意 |
マネージドノードプールの構成。 |
|
| enable |
boolean |
任意 |
マネージドノードプールを有効にするかどうかを指定します。有効な値:
デフォルト値: |
true |
| auto_repair |
boolean |
任意 |
ノードを自動的に修復するかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| auto_repair_policy |
object |
任意 |
自動修復ノードポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| approval_required |
boolean |
任意 |
ノード修復に手動承認が必要かどうかを指定します。 |
|
| 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 |
| auto_upgrade_runtime |
boolean |
任意 |
ランタイムの自動スペックアップを許可するかどうかを指定します。このパラメーターは
デフォルト値: |
false |
| auto_upgrade_os |
boolean |
任意 |
オペレーティングシステムの自動スペックアップを許可するかどうかを指定します。このパラメーターは
デフォルト値: |
false |
upgrade_config
deprecated
|
object |
任意 |
[このフィールドは非推奨です] 代わりに上位レベルの 自動スペックアップ構成。このパラメーターは |
|
auto_upgrade
deprecated
|
boolean |
任意 |
[このフィールドは非推奨です] 代わりに上位レベルの 自動スペックアップを有効にするかどうかを指定します:
デフォルト値: |
true |
| surge |
integer |
任意 |
追加ノードの数。このパラメーターと スペックアップ中はノードが使用できなくなります。クラスターのワークロードを補うために追加ノードを作成できます。 説明
追加ノード数は現在のノード数を超えないようにしてください。 |
5 |
| surge_percentage |
integer |
任意 |
追加ノードの割合。このパラメーターと 追加ノード数 = 追加ノードの割合 × ノード数。たとえば、割合が 50% に設定され、既存のノードが 6 つある場合、追加ノード数 = 50% × 6 = 3 となります。 |
0 |
| max_unavailable |
integer |
任意 |
使用不可ノードの最大値。 有効な値: [1,1000]。 デフォルト値: 1。 |
1 |
| auto_fault_diagnosis |
boolean |
任意 |
ノード自己修復のための ECS 障害検出を有効にするかどうかを指定します。 |
|
| scaling_group |
object |
任意 |
ノードプールのスケーリンググループ構成。 |
|
| vswitch_ids |
array |
任意 |
vSwitch ID のリスト。有効な値: [1,8]。 説明
高可用性を確保するため、異なるゾーンの vSwitch を選択してください。 |
|
|
string |
任意 |
vSwitch の ID。 |
vsw-wz9uwxhawmtzg7u9h**** |
|
| instance_types |
array |
任意 |
ノードインスタンスタイプのリスト。代替として複数のインスタンスタイプを選択できます。各ノードの作成時、システムは最初のスペックから順にインスタンスの購入を試み、作成が成功するまで続けます。実際に購入されるインスタンスタイプは、在庫状況によって異なる場合があります。 サポートされているインスタンスタイプの数: [1,10]。 |
|
|
string |
任意 |
インスタンスタイプ。詳細については、「インスタンスファミリー」(~~25378~~) を参照してください。 |
ecs.c6.large |
|
| instance_charge_type |
string |
任意 |
ノードプール内のノードの課金方法。有効な値:
デフォルト値: |
PostPaid |
| period |
integer |
任意 |
ノードプール内のインスタンスのサブスクリプション期間。このパラメーターは
|
1 |
| period_unit |
string |
任意 |
ノードプール内のインスタンスの課金サイクル。このパラメーターは
デフォルト値: |
Month |
| auto_renew |
boolean |
任意 |
インスタンスの自動更新を有効にするかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| auto_renew_period |
integer |
任意 |
各自動更新サイクルの持続時間。有効な値:
デフォルト値: 1。 |
1 |
| spot_strategy |
string |
任意 |
スポットインスタンスのタイプ。有効な値:
詳細については、「スポットインスタンス」(~~157759~~) を参照してください。 |
SpotWithPriceLimit |
| 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]。 値は max{20, ImageSize} 以上である必要があります。 デフォルト値: max{40, ImageId パラメーターに対応するイメージサイズ}。 |
120 |
| system_disk_performance_level |
string |
任意 |
ノードシステムクラウドディスクのパフォーマンスレベル。このパラメーターは ESSD クラウドディスクに対してのみ効果を持ちます。パフォーマンスレベルはクラウドディスクのサイズに関連しています。詳細については、「ESSD」(~~122389~~) を参照してください。
|
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_provisioned_iops |
integer |
任意 |
ノードシステムクラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。 有効な値: 0 ~ min{50,000, 1000 × capacity - baseline performance}。ベースラインパフォーマンス = min{1,800 + 50 × capacity, 50000}。 このパラメーターは |
1000 |
| system_disk_bursting_enabled |
boolean |
任意 |
ノードシステムクラウドディスクのバースト (パフォーマンスバースト) を有効にするかどうかを指定します。有効な値:
このパラメーターは |
true |
| data_disks |
array |
任意 |
ノード用のデータクラウドディスク構成。有効な値: [0,10]。最大 10 個のデータクラウドディスクを追加できます。 |
|
| data_disk |
任意 |
ノード用のデータクラウドディスク構成。 |
||
| disk_init |
array |
任意 |
ブロックデバイスの初期化構成。 |
|
|
DiskInit |
任意 |
ブロックデバイスの初期化構成。 |
||
| key_pair |
string |
任意 |
キーペアの名前。このパラメーターと |
pro-nodepool |
| login_password |
string |
任意 |
SSH ログインパスワード。このパラメーターと |
Hello1234 |
| internet_charge_type |
string |
任意 |
パブリック IP アドレスの課金タイプ。有効な値:
|
PayByBandwidth |
| internet_max_bandwidth_out |
integer |
任意 |
ノードパブリック IP アドレスの最大値のアウトバウンド帯域幅。単位: Mbit/s。有効な値: [1,100]。 |
5 |
| tags |
array |
任意 |
ECS インスタンスにのみ追加されるタグ。 タグキーは重複不可で、最大 128 文字です。タグキーおよびタグ値は "aliyun" または "acs:" で始めることができず、"https://" または "http://" を含むことはできません。 |
|
| tag |
任意 |
ECS インスタンスのタグ。 |
||
| desired_size |
integer |
任意 |
ノードプールの希望ノード数。 ノードプールが維持すべきノードの総数。クラスターコンポーネントが正常に動作するように、少なくとも 2 つのノードを構成してください。希望ノード数を調整することで、ノードプールをスケールインまたはスケールアウトできます。 ノードを作成する必要がない場合は、このパラメーターを 0 に設定し、後でノード数を手動で調整してください。 |
2 |
| multi_az_policy |
string |
任意 |
スケーリンググループ内の ECS インスタンスに対するマルチゾーンスケーリングポリシー。有効な値:
デフォルト値: |
BALANCE |
| 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 |
任意 |
|
true |
| rds_instances |
array |
任意 |
ApsaraDB RDS インスタンスのリスト。 |
|
|
string |
任意 |
ApsaraDB RDS インスタンスの ID。RDS インスタンスリストが指定されている場合、クラスターノードの ECS インスタンスは自動的に RDS ホワイトリストに追加されます。 [parameters.2.schema.properties |
rds-xxx |
|
| private_pool_options |
object |
任意 |
The private node pool configuration. |
|
| id |
string |
任意 |
The private node pool ID. When |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
任意 |
The private node pool type and private pool capacity option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instance startup. Valid values:
|
Open |
platform
deprecated
|
string |
任意 |
This parameter is deprecated. Use the The operating system platform. Valid values:
|
AliyunLinux |
| instance_patterns |
array |
任意 |
The instance attribute configuration. |
|
| instance_patterns |
任意 |
The instance attributes. |
||
| deploymentset_id |
string |
任意 |
The deployment set to which the ECS instances created by the node pool belong. This setting takes effect only on new nodes. The deployment set of existing nodes is not changed. |
ds-bp1d19mmbsv3jf6xxxxx |
| security_group_ids |
array |
任意 |
The list of security group IDs. |
|
|
string |
任意 |
The security group ID. |
sg-wz9a8g2mt6x5ll****** |
|
| resource_pool_options |
object |
任意 |
The resource pool and resource pool strategy used when creating instances. Note the following when you set this parameter: This parameter takes effect only when creating pay-as-you-go instances. This parameter cannot be set together with private_pool_options.match_criteria or private_pool_options.id. |
|
| strategy |
string |
任意 |
The resource pool strategy used when creating instances. Resource pools include private pools generated after an elasticity assurance or capacity reservation takes effect, and public pools, for instance startup. Valid values: PrivatePoolFirst: private pool first. When this strategy is selected, if resouce_pool_options.private_pool_ids is specified, the specified private pools are used first. If no private pool is specified or the specified private pool capacity is insufficient, open-type private pools are automatically matched. If no matching private pool is available, public pool resources are used to create instances. PrivatePoolOnly: private pool only. When this strategy is selected, you must specify resouce_pool_options.private_pool_ids. If the specified private pool capacity is insufficient, the instance fails to start. None: no resource pool strategy is used. Default value: None. |
PrivatePoolFirst |
| private_pool_ids |
array |
任意 |
The list of private pool IDs, which are elasticity assurance IDs or capacity reservation IDs. Only Target mode private pool IDs can be specified. Valid values of N: 1 to 20. |
|
|
string |
任意 |
The private pool ID, which is an elasticity assurance ID or capacity reservation ID. Only Target mode private pool IDs can be specified. |
eap-bp67acfmxazb4**** |
|
| system_disk_snapshot_policy_id |
string |
任意 |
The snapshot policy for the system cloud disk. |
sp-0jl6xnmme8v7o935**** |
| kubernetes_config |
object |
任意 |
The cluster-related configuration. |
|
| labels |
array |
任意 |
The node labels. Labels are added to the Kubernetes cluster nodes. Label definition rules:
|
|
| tag |
任意 |
The node label. |
||
| taints |
array |
任意 |
The node taint configuration. |
|
| taint |
任意 |
The node taint configuration. |
||
| runtime |
string |
任意 |
The container runtime name. ACK supports the following three container runtimes:
Default value: containerd. |
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:
Default value: |
none |
| unschedulable |
boolean |
任意 |
Specifies whether the nodes added during scale-out are unschedulable.
|
false |
| user_data |
string |
任意 |
The instance user data. After the node joins the cluster, the specified user data script is executed. For more information, see User data scripts. |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| cms_enabled |
boolean |
任意 |
Specifies whether to install the CloudMonitor agent on ECS nodes. After installation, you can view monitoring information of the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. Valid values:
Default value: |
true |
| pre_user_data |
string |
任意 |
The pre-instance user data. Before the node joins the cluster, the specified pre-user data script is executed. For more information, see User data scripts. |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| node_name_mode |
string |
任意 |
The custom node name parameter. A node name consists of three parts: prefix + node IP + 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 node IP is the full private IP address of the node. The parameter contains four parts separated by commas. For example, if you pass in the string "customized,aliyun,ip,com" (where "customized" and "ip" are fixed strings, "aliyun" is the prefix, and "com" is the suffix), the node name is: aliyun.192.168.xxx.xxx.com. |
customized,aliyun,ip,com |
| tee_config |
object |
任意 |
The confidential computing cluster configuration. |
|
| tee_enable |
boolean |
任意 |
Specifies whether to enable confidential computing for the cluster. Valid values:
Default value: |
false |
| update_nodes |
boolean |
任意 |
Synchronously updates node labels and taints. |
true |
| concurrency |
boolean |
任意 |
Specifies whether to enable concurrency. |
true |
| eflo_node_group |
object |
任意 |
The Lingjun node pool configuration. (Not effective) |
|
| auto_attach_enabled |
string |
任意 |
Specifies whether to enable automatic addition for the Lingjun node pool. (Not effective) |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
The response body data. |
||
| task_id |
string |
The task ID. |
T-5fd211e924e1d00787000293 |
| nodepool_id |
string |
ノードプールの ID。 |
np737c3ac1ac684703b9e10673aa2c**** |
| request_id |
string |
The request ID. |
687C5BAA-D103-4993-884B-C35E4314**** |
例
成功レスポンス
JSONJSON
{
"task_id": "T-5fd211e924e1d00787000293",
"nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
"request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。