ModifyClusterNodePool 操作は、ノードプールの構成を更新します。
今すぐお試しください
テスト
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 つのリソースは 1 つのリソースグループにのみ属することができます。必要に応じて、リソースグループをプロジェクト、アプリケーション、組織などの概念にマッピングできます。 |
rg-acfmyvw3wjm**** |
| auto_scaling |
object |
任意 |
オートスケーリングの構成。 |
|
| enable |
boolean |
任意 |
オートスケーリングを有効にするかどうかを指定します。有効な値:
このパラメーターを false に設定した場合、`auto_scaling` 内の他のパラメーターは有効になりません。 デフォルト値:`false`。 |
true |
type
deprecated
|
string |
任意 |
オートスケーリングのタイプ。このパラメーターは、スケーリングするインスタンスのタイプを指定します。有効な値:
デフォルト値:`cpu`。 |
cpu |
| max_instances |
integer |
任意 |
ノードプールに作成できるインスタンスの最大数。このパラメーターには既存のインスタンスは含まれません。このパラメーターは `enable=true` の場合にのみ有効になります。 値は [min_instances, 2000] の範囲内である必要があります。デフォルト値は 0 です。 |
10 |
| min_instances |
integer |
任意 |
ノードプールに作成できるインスタンスの最小数。このパラメーターには既存のインスタンスは含まれません。このパラメーターは `enable=true` の場合にのみ有効になります。 値は [0, max_instances] の範囲内である必要があります。デフォルト値は 0 です。 説明
|
2 |
is_bond_eip
deprecated
|
boolean |
任意 |
[このパラメーターは非推奨です] このパラメーターは非推奨です。代わりに `internet_charge_type` と `internet_max_bandwidth_out` を使用してください。
デフォルト値:`false`。 |
null |
eip_internet_charge_type
deprecated
|
string |
任意 |
[このパラメーターは非推奨です] 代わりに `internet_charge_type` と `internet_max_bandwidth_out` を使用してください。 EIP の課金方法。有効な値:
デフォルト値:`PayByBandwidth`。 |
null |
eip_bandwidth
deprecated
|
integer |
任意 |
[このパラメーターは非推奨です] 代わりに `internet_charge_type` と `internet_max_bandwidth_out` を使用してください。 EIP のピーク帯域幅。 有効値の範囲:[1,100]。単位:Mbit/s。 |
null |
| management |
object |
任意 |
マネージドノードプールの構成。 |
|
| enable |
boolean |
任意 |
マネージドノードプール機能を有効にするかどうかを指定します。有効な値:
デフォルト値:`false`。 |
true |
| auto_repair |
boolean |
任意 |
ノードの自動修復を有効にするかどうかを指定します。このパラメーターは `enable=true` の場合にのみ有効になります。
デフォルト値:`true` |
true |
| auto_repair_policy |
object |
任意 |
ノードの自動修復ポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは `auto_repair=true` の場合にのみ有効になります。有効な値:
デフォルト値:`true` |
true |
| approval_required |
boolean |
任意 |
ノードの修復に手動承認が必要かどうかを指定します。 |
|
| auto_repair_policy_id |
string |
任意 |
自動修復ポリシーの ID。 |
r-xxxxxxxxxx |
| auto_vul_fix |
boolean |
任意 |
CVE 脆弱性を自動的に修正するかどうかを指定します。このパラメーターは `enable=true` の場合にのみ有効になります。
デフォルト値:`true`。 |
true |
| auto_vul_fix_policy |
object |
任意 |
CVE 脆弱性を自動的に修正するためのポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは `auto_vul_fix=true` の場合にのみ有効になります。有効な値:
デフォルト値:`true` |
true |
| vul_level |
string |
任意 |
自動修正が許可されている脆弱性レベル。レベルはカンマ (,) で区切られます。例:`asap,later`。サポートされている脆弱性レベル:
デフォルト値:`asap`。 |
asap,nntf |
| exclude_packages |
string |
任意 |
脆弱性修正中に除外すべきパッケージを指定します。 デフォルト値:`kernel`。 |
kernel |
| auto_upgrade |
boolean |
任意 |
ノードの自動アップグレードを有効にするかどうかを指定します。このパラメーターは `enable=true` の場合にのみ有効になります。
デフォルト値:`true` |
true |
| auto_upgrade_policy |
object |
任意 |
自動アップグレードポリシー。 |
|
| auto_upgrade_kubelet |
boolean |
任意 |
kubelet の自動アップグレードを許可するかどうかを指定します。このパラメーターは `auto_upgrade=true` の場合にのみ有効になります。有効な値:
デフォルト値:`true` |
true |
| auto_upgrade_runtime |
boolean |
任意 |
ランタイムの自動アップグレードを許可するかどうかを指定します。このパラメーターは `auto_upgrade=true` の場合にのみ有効になります。有効な値:
デフォルト値:`true`。 |
false |
| auto_upgrade_os |
boolean |
任意 |
オペレーティングシステムの自動アップグレードを許可するかどうかを指定します。このパラメーターは `auto_upgrade=true` の場合にのみ有効になります。有効な値:
デフォルト値:`false`。 |
false |
upgrade_config
deprecated
|
object |
任意 |
[このパラメーターは非推奨です] 代わりに上位レベルの `auto_upgrade` パラメーターを使用してください。 自動アップグレードの構成。このパラメーターは `enable=true` の場合にのみ有効になります。 |
|
auto_upgrade
deprecated
|
boolean |
任意 |
[このパラメーターは非推奨です] 代わりに上位レベルの `auto_upgrade` パラメーターを使用してください。 自動アップグレードを有効にするかどうか:
デフォルト値:`true`。 |
true |
| surge |
integer |
任意 |
追加ノードの数。`surge` と `surge_percentage` のいずれか一方のみを指定できます。 アップグレード中にノードが利用できなくなる場合があります。追加のノードを作成してワークロードを補うことができます。 説明
追加ノードの数は、ノードプール内のノードの総数を超えることはできません。 |
5 |
| surge_percentage |
integer |
任意 |
追加ノードの割合。`surge` と `surge_percentage` のいずれか一方のみを指定できます。 追加ノード数 = 追加ノードの割合 × ノード数。たとえば、追加ノードの割合を 50% に設定し、既存のノード数が 6 の場合、追加ノード数は 50% × 6 = 3 となります。 |
0 |
| max_unavailable |
integer |
任意 |
利用不可能なノードの最大数。 有効値の範囲:[1,1000] デフォルト値:1。 |
1 |
| auto_fault_diagnosis |
boolean |
任意 |
||
| scaling_group |
object |
任意 |
ノードプールのスケーリンググループの構成。 |
|
| vswitch_ids |
array |
任意 |
vSwitch ID のリスト。値は 1~8 個の vSwitch ID のリストにすることができます。 説明
高可用性を確保するために、異なるゾーンの vSwitch を選択することを推奨します。 |
|
|
string |
任意 |
vSwitch ID。 |
vsw-wz9uwxhawmtzg7u9h**** |
|
| instance_types |
array |
任意 |
ノードインスタンスタイプのリスト。代替として複数のインスタンスタイプを選択できます。ノードが作成されるとき、システムは最初のインスタンスタイプから開始し、ノードが作成されるまで続けます。ノードの作成に使用されるインスタンスタイプは、在庫状況によって異なります。 サポートされるインスタンスタイプの数は 1~10 です。 |
|
|
string |
任意 |
インスタンスタイプ。詳細については、「インスタンスファミリー」をご参照ください。 |
ecs.c6.large |
|
| instance_charge_type |
string |
任意 |
ノードプール内のノードの課金方法。有効な値:
デフォルト値:`PostPaid`。 |
PostPaid |
| period |
integer |
任意 |
ノードプール内のノードのサブスクリプション期間。このパラメーターは、`instance_charge_type` が `PrePaid` に設定されている場合にのみ有効で、必須です。
|
1 |
| period_unit |
string |
任意 |
ノードプール内のノードの課金サイクル。このパラメーターは、`instance_charge_type` が `PrePaid` に設定されている場合に必須です。
デフォルト値:`Month`。 |
Month |
| auto_renew |
boolean |
任意 |
ノードの自動更新を有効にするかどうかを指定します。このパラメーターは、`instance_charge_type` が `PrePaid` に設定されている場合にのみ有効になります。有効な値:
デフォルト値:`false`。 |
true |
| auto_renew_period |
integer |
任意 |
自動更新期間。有効な値:
デフォルト値:1。 |
1 |
| spot_strategy |
string |
任意 |
スポットインスタンスの入札ポリシー。有効な値:
詳細については、「スポットインスタンス」をご参照ください。 |
SpotWithPriceLimit |
| spot_price_limit |
array<object> |
任意 |
スポットインスタンスの価格範囲。 |
|
|
object |
任意 |
スポットインスタンスの価格範囲。 |
||
| instance_type |
string |
任意 |
スポットインスタンスのインスタンスタイプ。 |
ecs.c6.large |
| price_limit |
string |
任意 |
単一インスタンスの最大価格。 単位:USD/時間。 |
0.39 |
| image_type |
string |
任意 |
OS ディストリビューション。このパラメーターを使用してノード OS を指定することを推奨します。有効な値:
|
AliyunLinux3 |
| image_id |
string |
任意 |
カスタムイメージの ID。`DescribeKubernetesVersionMetadata` 操作を呼び出して、システムでサポートされているイメージをクエリできます。デフォルトでは、最新のシステムイメージが使用されます。 |
aliyun_3_x64_20G_alibase_20241218.vhd |
| system_disk_category |
string |
任意 |
システムディスクのタイプ。有効な値:
デフォルト値:`cloud_efficiency`。 |
cloud_efficiency |
| system_disk_categories |
array |
任意 |
システムディスクのマルチディスクタイプ。優先度の高いタイプのディスクが利用できない場合、システムは自動的に次の優先度のタイプを試してシステムディスクを作成します。 |
|
|
string |
任意 |
ノードシステムのマルチディスクタイプ。 有効な値:
|
cloud_essd |
|
| system_disk_size |
integer |
任意 |
システムディスクのサイズ。単位:GiB。 有効値の範囲:[20,2048]。 このパラメーターの値は、max{20, ImageSize} 以上である必要があります。 デフォルト値:max{40, ImageId パラメーターで指定されたイメージの ImageSize}。 |
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_provisioned_iops |
integer |
任意 |
システムディスクの事前設定された読み取り/書き込み IOPS。 有効値の範囲:0~min{50,000, 1000 × 容量 - ベースライン IOPS}。ベースライン IOPS = min{1,800 + 50 × 容量, 50000}。 このパラメーターは、`system_disk_category` が `cloud_auto` に設定されている場合にのみ設定できます。詳細については、「ESSD AutoPL ディスク」をご参照ください。 |
1000 |
| system_disk_bursting_enabled |
boolean |
任意 |
システムディスクのバースト機能を有効にするかどうかを指定します。有効な値:
このパラメーターは、`system_disk_category` が `cloud_auto` に設定されている場合にのみ設定できます。詳細については、「ESSD AutoPL ディスク」をご参照ください。 |
true |
| data_disks |
array |
任意 |
ノード上のデータディスクの構成。最大 10 個のデータディスクを追加できます。値は [0, 10] の範囲内である必要があります。 |
|
| data_disk |
任意 |
データディスクの構成。 |
||
| disk_init |
array |
任意 |
ブロックデバイスの初期化構成。 |
|
|
DiskInit |
任意 |
ブロックデバイスの初期化構成。 |
||
| key_pair |
string |
任意 |
キーペアの名前。`key_pair` または `login_password` を設定する必要があります。ノードプールがマネージドノードプールの場合、`key_pair` のみがサポートされます。 |
pro-nodepool |
| login_password |
string |
任意 |
SSH ログインパスワード。`key_pair` または `login_password` を設定する必要があります。パスワードは 8~30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。 |
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 インスタンスのスケーリングポリシー。有効な値:
デフォルト値:`PRIORITY`。 |
BALANCE |
| scaling_policy |
string |
任意 |
スケーリンググループのスケーリングモード。有効な値:
|
release |
| on_demand_base_capacity |
integer |
任意 |
スケーリンググループでプロビジョニングする必要があるオンデマンドインスタンスの最小数。有効値の範囲:[0,1000]。オンデマンドインスタンスの数がこの値を下回る場合、システムはオンデマンドインスタンスを優先的に作成します。 |
0 |
| on_demand_percentage_above_base_capacity |
integer |
任意 |
オンデマンドインスタンスの最小数 (`on_demand_base_capacity`) を超えるインスタンスの中でのオンデマンドインスタンスの割合。有効値の範囲:[0,100]。 |
20 |
| spot_instance_pools |
integer |
任意 |
利用可能なインスタンスタイプの数。スケーリンググループは、最も低コストで利用可能な複数のインスタンスタイプのスポットインスタンスを作成します。有効値の範囲:[1,10]。 |
5 |
| spot_instance_remedy |
boolean |
任意 |
スポットインスタンスのインスタンス置換機能を有効にするかどうかを指定します。この機能が有効な場合、スケーリンググループは、スポットインスタンスが回収されるというシステムメッセージを受信したときに、新しいインスタンスを作成してスポットインスタンスを置き換えます。有効な値:
|
false |
| compensate_with_on_demand |
boolean |
任意 |
`multi_az_policy` が `COST_OPTIMIZED` に設定されている場合、価格や在庫などの理由でスポットインスタンスを作成できないときに、必要な ECS インスタンス数を満たすためにシステムが従量課金インスタンスを自動的に作成することを許可するかどうかを指定します。有効な値:
|
true |
| rds_instances |
array |
任意 |
RDS インスタンスのリスト。 |
|
|
string |
任意 |
RDS インスタンスの ID。RDS インスタンスのリストを指定すると、クラスター内の ECS インスタンスは自動的に RDS インスタンスのホワイトリストに追加されます。 |
rds-xxx |
|
| private_pool_options |
object |
任意 |
プライベートノードプールの構成。 |
|
| id |
string |
任意 |
プライベートノードプールの ID。`match_criteria` が `Target` に設定されている場合、プライベートプールの ID を指定する必要があります。 |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
任意 |
プライベートノードプールのタイプ。このパラメーターは、インスタンス作成時のプライベートプール容量オプションを指定します。プライベートプールの容量は、弾力性保証または容量予約サービスが有効になった後に生成されます。インスタンスを作成するときに容量オプションを選択できます。有効な値:
|
Open |
platform
deprecated
|
string |
任意 |
[このパラメーターは非推奨です] 代わりに `image_type` パラメーターを使用してください。 OS プラットフォーム。有効な値:
|
AliyunLinux |
| instance_patterns |
array |
任意 |
インスタンス属性の構成。 |
|
| instance_patterns |
任意 |
インスタンス属性。 |
||
| deploymentset_id |
string |
任意 |
ノードプール内の ECS インスタンスが属するデプロイメントセットの ID。このパラメーターは増分ノードにのみ有効です。既存のノードのデプロイメントセットは変更されません。 |
ds-bp1d19mmbsv3jf6xxxxx |
| security_group_ids |
array |
任意 |
セキュリティグループ ID のリスト。 |
|
|
string |
任意 |
セキュリティグループ ID。 |
sg-wz9a8g2mt6x5ll****** |
|
| resource_pool_options |
object |
任意 |
インスタンス作成時に使用されるリソースプールとリソースプールポリシー。注意: このパラメーターは従量課金インスタンスを作成する場合にのみ有効です。 このパラメーターは `private_pool_options.match_criteria` および `private_pool_options.id` と同時に指定することはできません。 |
|
| strategy |
string |
任意 |
インスタンス作成時に使用されるリソースプールポリシー。リソースプールには、弾力性保証または容量予約サービスが有効になった後に生成されるプライベートプールと、パブリックプールが含まれます。インスタンスを作成するときにリソースプールを選択できます。有効な値: PrivatePoolFirst:プライベートプールが最初に使用されます。`resouce_pool_options.private_pool_ids` を指定した場合、指定されたプライベートプールが最初に使用されます。プライベートプールを指定しない場合、または指定されたプライベートプールの容量が不足している場合、オープンなプライベートプールの容量が自動的に照合されます。一致するプライベートプールが見つからない場合、パブリックプールのリソースがインスタンスの作成に使用されます。 PrivatePoolOnly:プライベートプールのみが使用されます。このオプションを選択した場合、`resouce_pool_options.private_pool_ids` を指定する必要があります。指定されたプライベートプールの容量が不足している場合、インスタンスの作成は失敗します。 None:リソースプールポリシーは使用されません。 デフォルト値:None。 |
PrivatePoolFirst |
| private_pool_ids |
array |
任意 |
プライベートプール ID のリスト。ID は弾力性保証または容量予約の ID にすることができます。Target モードのプライベートプールの ID のみ指定できます。N は 1~20 の整数です。 |
|
|
string |
任意 |
プライベートプールの ID。ID は弾力性保証または容量予約の ID にすることができます。Target モードのプライベートプールの ID のみ指定できます。 |
eap-bp67acfmxazb4**** |
|
| system_disk_snapshot_policy_id |
string |
任意 |
システムディスクのスナップショットポリシー。 |
sp-0jl6xnmme8v7o935**** |
| kubernetes_config |
object |
任意 |
Kubernetes の構成。 |
|
| labels |
array |
任意 |
ノードに追加するラベル。ラベルはキーと値のペアである必要があります。ルール:
|
|
| tag |
任意 |
ノードのラベル。 |
||
| taints |
array |
任意 |
ノードの Taint 構成。 |
|
| taint |
任意 |
ノードの Taint 構成。 |
||
| runtime |
string |
任意 |
コンテナランタイムの名前。ACK は次のコンテナランタイムをサポートしています。
デフォルト値:containerd。 |
containerd |
| runtime_version |
string |
任意 |
コンテナランタイムのバージョン。 |
1.6.38 |
| cpu_policy |
string |
任意 |
ノードの CPU 管理ポリシー。Kubernetes 1.12.6 以降を実行するクラスターでは、次のポリシーがサポートされています:
デフォルト値:`none`。 |
none |
| unschedulable |
boolean |
任意 |
スケールアウトされたノードがスケジューリング不可かどうかを指定します。
|
false |
| user_data |
string |
任意 |
インスタンスのユーザーデータ。ノードがクラスターに追加された後、指定されたインスタンスユーザーデータスクリプトが実行されます。詳細については、「ユーザーデータスクリプト」をご参照ください。 |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| cms_enabled |
boolean |
任意 |
ECS ノードに Cloud Monitor をインストールするかどうかを指定します。Cloud Monitor をインストールすると、Cloud Monitor コンソールで作成された ECS インスタンスのモニタリング情報を表示できます。この機能を有効にすることを推奨します。有効な値:
デフォルト値:`false`。 |
true |
| pre_user_data |
string |
任意 |
インスタンスの事前カスタムデータ。ノードがクラスターに追加される前に、指定されたインスタンス事前カスタムデータスクリプトが実行されます。詳細については、「ユーザーデータスクリプト」をご参照ください。 |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| node_name_mode |
string |
任意 |
ノード名をカスタマイズするためのパラメーター。ノード名は、プレフィックス、ノードの IP アドレス、サフィックスの 3 つの部分で構成されます。 プレフィックスとサフィックスは、それぞれピリオド (.) で区切られた 1 つ以上の部分を含むことができます。各部分は、小文字、数字、ハイフン (-) を含むことができます。ノード名は、小文字または数字で始まり、終わる必要があります。ノードの IP アドレスは、ノードの完全なプライベート IP アドレスです。 パラメーターは、カンマ (,) で区切られた 4 つの部分で構成されます。たとえば、文字列 "customized,aliyun,ip,com" (ここで "customized" と "ip" は固定文字列、"aliyun" はプレフィックス、"com" はサフィックス) を渡すと、ノード名は aliyun.192.168.xxx.xxx.com になります。 |
customized,aliyun,ip,com |
| tee_config |
object |
任意 |
機密計算用 Kubernetes クラスターの構成。 |
|
| tee_enable |
boolean |
任意 |
機密計算用 Kubernetes クラスターを有効にするかどうかを指定します。有効な値:
デフォルト値:`false`。 |
false |
| update_nodes |
boolean |
任意 |
ノードのラベルと Taint を同期的に更新します。 |
true |
| concurrency |
boolean |
任意 |
タスクを同時に実行するかどうかを指定します。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディ。 |
||
| task_id |
string |
タスク ID。 |
T-5fd211e924e1d00787000293 |
| nodepool_id |
string |
ノードプール ID。 |
np737c3ac1ac684703b9e10673aa2c**** |
| request_id |
string |
リクエスト ID。 |
687C5BAA-D103-4993-884B-C35E4314**** |
例
成功レスポンス
JSONJSON
{
"task_id": "T-5fd211e924e1d00787000293",
"nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
"request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。