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 |
任意 |
auto scaling の構成。 |
|
| enable |
boolean |
任意 |
auto scaling を有効にするかどうかを指定します。有効な値:
このパラメーターを false に設定した場合、auto_scaling 内の他のパラメーターは有効になりません。 デフォルト値: |
true |
type
deprecated
|
string |
任意 |
auto scaling のタイプ。スケーリングはインスタンスタイプに基づいて実行されます。有効な値:
デフォルト値: |
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 を使用してください。
デフォルト値: |
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 |
任意 |
ノードの自動修復を有効にするかどうかを指定します。このパラメーターは、enable が true に設定されている場合にのみ有効になります。
デフォルト値: |
true |
| auto_repair_policy |
object |
任意 |
ノードの自動修復ポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは、auto_repair が true に設定されている場合にのみ有効になります。有効な値:
デフォルト値: |
true |
| approval_required |
boolean |
任意 |
ノードの修復に手動承認が必要かどうかを指定します。 |
|
| auto_repair_policy_id |
string |
任意 |
自動修復ポリシーの ID。 |
r-xxxxxxxxxx |
| auto_vul_fix |
boolean |
任意 |
CVE 脆弱性の自動修復を有効にするかどうかを指定します。このパラメーターは、enable が true に設定されている場合にのみ有効になります。
デフォルト値: |
true |
| auto_vul_fix_policy |
object |
任意 |
CVE 脆弱性の自動修復ポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは、auto_vul_fix が true に設定されている場合にのみ有効になります。有効な値:
デフォルト値: |
true |
| vul_level |
string |
任意 |
自動的に修正することが許可されている CVE 脆弱性レベル。複数のレベルはコンマ (,) で区切ります。例:
デフォルト値: |
asap,nntf |
| exclude_packages |
string |
任意 |
CVE 脆弱性の修復中に除外すべきパッケージ。 デフォルト値: |
kernel |
| auto_upgrade |
boolean |
任意 |
ノードの自動アップグレードを有効にするかどうかを指定します。このパラメーターは、enable が true に設定されている場合にのみ有効になります。
デフォルト値: |
true |
| auto_upgrade_policy |
object |
任意 |
自動アップグレードポリシー。 |
|
| auto_upgrade_kubelet |
boolean |
任意 |
kubelet の自動アップグレードを許可するかどうかを指定します。このパラメーターは、auto_upgrade が true に設定されている場合にのみ有効になります。有効な値:
デフォルト値: |
true |
| auto_upgrade_runtime |
boolean |
任意 |
ランタイムの自動アップグレードを許可するかどうかを指定します。このパラメーターは、auto_upgrade が true に設定されている場合にのみ有効になります。有効な値:
デフォルト値: |
false |
| auto_upgrade_os |
boolean |
任意 |
OS の自動アップグレードを許可するかどうかを指定します。このパラメーターは、auto_upgrade が true に設定されている場合にのみ有効になります。有効な値:
デフォルト値: |
false |
upgrade_config
deprecated
|
object |
任意 |
[このパラメーターは非推奨です] 代わりに 自動アップグレード構成。このパラメーターは、enable が true に設定されている場合にのみ有効になります。 |
|
auto_upgrade
deprecated
|
boolean |
任意 |
[このパラメーターは非推奨です] 代わりに 自動アップグレードを有効にするかどうかを指定します:
デフォルト値: |
true |
| surge |
integer |
任意 |
追加ノードの数。surge と surge_percentage のいずれか一方のみを指定できます。 アップグレード中にノードが利用できなくなる可能性があります。追加のノードを作成して、サービスの継続性を確保できます。 説明
追加ノードの数は、ノードプール内のノードの総数を超えることはできません。 |
5 |
| surge_percentage |
integer |
任意 |
追加ノードの割合。surge と surge_percentage のいずれか一方のみを指定できます。 追加ノードの数 = 追加ノードの割合 × ノード数。たとえば、追加ノードの割合を 50% に設定し、ノード数が 6 の場合、追加ノードの数は 3 (50% × 6) です。 |
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 |
| period |
integer |
任意 |
ノードプール内のノードのサブスクリプション期間。このパラメーターは、instance_charge_type が PrePaid に設定されている場合にのみ有効になり、必須です。
|
1 |
| period_unit |
string |
任意 |
ノードプール内のノードの課金サイクル。このパラメーターは、instance_charge_type が PrePaid に設定されている場合に必須です。
デフォルト値: |
Month |
| auto_renew |
boolean |
任意 |
ノードの自動更新を有効にするかどうかを指定します。このパラメーターは、instance_charge_type が PrePaid に設定されている場合にのみ有効になります。有効な値:
デフォルト値: |
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 |
| 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」をご参照ください。
|
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, 1,000 × 容量 - ベースライン IOPS}。ベースライン IOPS = min{1,800 + 50 × 容量, 50,000}。 このパラメーターは、system_disk_category が cloud_auto に設定されている場合にのみ設定できます。詳細については、「ESSD AutoPL ディスク」をご参照ください。 |
1000 |
| system_disk_bursting_enabled |
boolean |
任意 |
ノードのシステムディスクのバースト機能を有効にするかどうかを指定します。有効な値:
このパラメーターは、system_disk_category が cloud_auto に設定されている場合にのみ設定できます。詳細については、「ESSD AutoPL ディスク」をご参照ください。 |
true |
| data_disks |
array |
任意 |
ノードのデータディスクの構成。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 |
任意 |
ノードの最大パブリックアウトバウンド帯域幅。単位: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 |
任意 |
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 |
任意 |
ApsaraDB RDS インスタンスのリスト。 |
|
|
string |
任意 |
ApsaraDB RDS インスタンスの ID。ApsaraDB RDS インスタンスのリストを指定すると、クラスターノードの ECS インスタンスが自動的に ApsaraDB RDS インスタンスのホワイトリストに追加されます。 |
rds-xxx |
|
| private_pool_options |
object |
任意 |
プライベートノードプールの構成。 |
|
| id |
string |
任意 |
プライベートノードプールの ID。match_criteria を Target に設定した場合、プライベートプールの ID を指定する必要があります。 |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
任意 |
プライベートノードプールのタイプ。このパラメーターは、インスタンス作成のためのプライベートプール容量オプションを指定します。Elastic Assurance Service (EAS) または Capacity Reservation Service (CRS) が有効になると、プライベートプールが生成されます。プライベートプールを選択してインスタンスを起動できます。有効な値:
|
Open |
platform
deprecated
|
string |
任意 |
[このパラメーターは非推奨です] 代わりに OS プラットフォーム。有効な値:
|
AliyunLinux |
| instance_patterns |
array |
任意 |
インスタンスプロパティの構成。 |
|
| instance_patterns |
任意 |
インスタンスのプロパティ。 |
||
| deploymentset_id |
string |
任意 |
ノードプール内の ECS インスタンスが属するデプロイメントセット。このパラメーターは増分ノードにのみ有効です。既存のノードのデプロイメントセットは変更されません。 |
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 |
任意 |
インスタンスの作成に使用されるリソースプールポリシー。リソースプールには、Elastic Assurance Service (EAS) または Capacity Reservation Service (CRS) が有効になった後に生成されるプライベートプールと、パブリックプールが含まれます。リソースプールを選択してインスタンスを起動できます。有効な値: PrivatePoolFirst:システムはプライベートプールの使用を優先します。resouce_pool_options.private_pool_ids を指定した場合、システムは指定されたプライベートプールの使用を優先します。プライベートプールを指定しない場合、または指定されたプライベートプールが不十分な場合、システムは自動的に Open タイプのプライベートプールを照合します。適格なプライベートプールが見つからない場合、システムはパブリックリソースを使用してインスタンスを作成します。 PrivatePoolOnly:システムはプライベートプールのみを使用します。このオプションを選択した場合、resouce_pool_options.private_pool_ids を指定する必要があります。指定されたプライベートプールが不十分な場合、インスタンスの起動は失敗します。 None:システムはリソースプールポリシーを使用しません。 デフォルト値:None。 |
PrivatePoolFirst |
| private_pool_ids |
array |
任意 |
プライベートプール ID のリスト。プライベートプール ID は、EAS または CRS の ID です。Target モードのプライベートプールの ID のみ指定できます。N は 1 から 20 までの整数です。 |
|
|
string |
任意 |
プライベートプール ID。プライベートプール ID は、EAS または CRS の ID です。Target モードのプライベートプールの ID のみ指定できます。 |
eap-bp67acfmxazb4**** |
|
| system_disk_snapshot_policy_id |
string |
任意 |
システムディスクのスナップショットポリシー。 |
sp-0jl6xnmme8v7o935**** |
| kubernetes_config |
object |
任意 |
Kubernetes の構成。 |
|
| labels |
array |
任意 |
ノードラベル。Kubernetes クラスター内のノードにラベルを追加できます。ラベルを定義するためのルール:
|
|
| 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 |
| unschedulable |
boolean |
任意 |
スケールアウトされたノードがスケジュール不可かどうかを指定します。
|
false |
| user_data |
string |
任意 |
インスタンスのユーザーデータ。ノードがクラスターに追加された後、カスタムデータスクリプトが実行されます。詳細については、「ユーザーデータスクリプト」をご参照ください。 |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| cms_enabled |
boolean |
任意 |
ECS ノードに Cloud Monitor をインストールするかどうかを指定します。Cloud Monitor をインストールすると、Cloud Monitor コンソールで作成された ECS インスタンスのモニタリング情報を表示できます。この機能を有効にすることを推奨します。有効な値:
デフォルト値: |
true |
| pre_user_data |
string |
任意 |
インスタンスの事前カスタムデータ。ノードがクラスターに追加される前に、事前カスタムデータスクリプトが実行されます。詳細については、「ユーザーデータスクリプト」をご参照ください。 |
IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi |
| node_name_mode |
string |
任意 |
カスタムノード名パラメーター。ノード名は、プレフィックス、ノードの IP アドレス、およびサフィックスで構成されます プレフィックスとサフィックスは、ピリオド (.) で区切られた 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 |
| 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****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。