ModifyCluster - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

ModifyCluster オペレーションを呼び出すと、ACK クラスターの構成を変更できます。

操作説明

重要 2026年7月4日以降、リクエストパラメーターの instance_deletion_protection、ingress_loadbalancer_id、access_control_list は有効ではなくなります。変更の詳細については、「ACK クラスター管理に関連する入力パラメーターと出力パラメーターの変更および OpenAPI オペレーションの非推奨に関するお知らせ」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:ModifyCluster

update

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

cs:EnableApiServerEip
cs:ApiServerEipId

なし

リクエスト構文

PUT /api/v2/clusters/{ClusterId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID	cb95aa626a47740afbf6aa099b65****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディのパラメーターです。	true
api_server_eip	boolean	任意	API サーバーへのパブリックネットワークアクセス用に、EIP をクラスターにバインドするかどうかを指定します。有効な値は次のとおりです。 `true`：EIP をクラスターにバインドします。 `false`：EIP をクラスターにバインドしません。	true
api_server_eip_id	string	任意	クラスターの API サーバーにバインドされている EIP インスタンスの ID です。このパラメーターは、`api_server_eip` が `true` に設定されている場合にのみ有効です。	eip-wz9fnasl6dsfhmvci****
deletion_protection	boolean	任意	コンソールまたは API による意図しないクラスターの削除を防ぐため、クラスターの削除保護を有効化または無効化します。有効な値は次のとおりです。 `true`：クラスターの削除保護を有効化します。コンソールまたは API を使用してクラスターを削除することはできません。 `false`：クラスターの削除保護を無効化します。コンソールまたは API を使用してクラスターを削除できます。デフォルト値：`false`。	false
resource_group_id	string	任意	クラスターのリソースグループ ID です。	rg-acfmyvw3wjm****
maintenance_window	maintenance_window	任意	クラスターのメンテナンスウィンドウです。この機能は、ACK Pro マネージドクラスターでのみ利用可能です。
enable_rrsa	boolean	任意	RRSA 機能を有効化または無効化します。このパラメーターはマネージドクラスターのみ対応しています。有効な値は次のとおりです。 `true`：RRSA を有効化します。 `false`：RRSA を無効化します。	true
cluster_name	string	任意	カスタムのクラスター名です。名前には、数字、英字、漢字、ハイフン (-) を使用できます。長さは 1～63 文字で、ハイフン (-) で始めることはできません。	cluster-new-name
cluster_spec	string	任意	`cluster_type` を `ManagedKubernetes` に設定し、`profile` を構成する場合のクラスター仕様です。有効な値は次のとおりです。 `ack.pro.small`：Pro `ack.pro.xlarge`：Pro XL `ack.pro.2xlarge`：Pro 2XL `ack.pro.4xlarge`：Pro 4XL (有効化にはカスタマーサービスによる承認が必要です) Pro XL、Pro 2XL、Pro 4XL は、ACK Pro プロビジョニング済みコントロールプレーンによって提供される 3 つの階層です。これらの階層は、コントロールプレーンリソースを事前に割り当てて専有することにより、API の同時実行性と Pod のスケジューリングにおいて一貫した高性能を保証します。AI のトレーニングと推論、超大規模クラスター、およびミッションクリティカルなワークロードに適しています。 Pro およびプロビジョニング済みコントロールプレーンクラスターのクラスター管理料金については、「クラスター管理料金」をご参照ください。	ack.pro.small
system_events_logging	object	任意	システムイベントロギングの設定です。
enabled	boolean	任意	システムイベントロギングを有効にするかどうかを指定します。 true：システムイベントロギングを有効にします。 false：システムイベントロギングを無効にします。	true
logging_project	string	任意	システムイベントロギング用の LogProject 名です。	k8s-log-cb95aa626a47740afbf6aa099b65****
operation_policy	object	任意	クラスターの自動 O&M ポリシーです。
cluster_auto_upgrade	object	任意	クラスターの自動アップグレード設定です。
enabled	boolean	任意	クラスターの自動アップグレードを有効にするかどうかを指定します。 true：自動アップグレードを有効にします。 false：自動アップグレードを無効にします。	true
channel	string	任意	クラスターの自動アップグレードの頻度です。詳細については、「アップグレード頻度」をご参照ください。有効な値は次のとおりです。 `patch`：最新のパッチバージョン。 `stable`：2 番目に新しいマイナーバージョン。 `rapid`：最新のマイナーバージョン。	patch
api_server_custom_cert_sans	object	任意	カスタム IP アドレスまたはドメイン名を API サーバー証明書の SAN フィールドに追加して、クライアントアクセスを制御します。このパラメーターはマネージドクラスターのみ対応しています。
action	string	任意	SAN 設定を上書きするか、追加するかを指定します。有効な値は次のとおりです。 overwrite：既存の設定を上書きします。 append：既存の設定に追加します。	append
subject_alternative_names	array	任意	サブジェクト代替名 (SAN) のリストです。
	string	任意	SAN です。カスタム IP アドレスまたはドメイン名を指定できます。複数の IP アドレスまたはドメイン名はコンマ (,) で区切ります。	aliyun.xxx.com,192.168.xx.xx
vswitch_ids	array	任意	クラスターコントロールプレーンの vSwitch です。専用クラスターの場合、この変更は新規にスケールアウトされたコントロールプレーンノードにのみ適用されます。マネージドクラスターのコントロールプレーン vSwitch を変更する際は、次の点にご注意ください。このパラメーターは上書き更新のため、対象の vSwitch リストをすべて指定する必要があります。更新中、コントロールプレーンのコンポーネントが短時間再起動します。操作にご注意ください。コントロールプレーン、すべてのノードプール、コンテナネットワークのセキュリティグループを含むすべてにおいて、新しい vSwitch の IP CIDR ブロックに対するインバウンドおよびアウトバウンドトラフィックが許可されていることを確認してください。そうでない場合、ノードとコンテナは API サーバーに接続できません。新しいコントロールプレーン vSwitch に ACL ルールが設定されている場合は、これらのルールで vSwitch とクラスターノードおよびコンテナネットワークの IP CIDR ブロック間の通信が許可されていることを確認してください。
	string	任意	クラスターコントロールプレーン用の vSwitch です。	vsw-2ze4jvvvade1yk899****
control_plane_config	object	任意	専用クラスターのコントロールプレーン設定です。
charge_type	string	任意	コントロールプレーンノードインスタンスの課金方法です。有効な値は次のとおりです。 `PrePaid`：サブスクリプション。 `PostPaid`：従量課金。デフォルト値：`PostPaid`。	PostPaid
period	integer	任意	コントロールプレーンノードインスタンスのサブスクリプション期間です。このパラメーターは、`charge_type` が `PrePaid` に設定されている場合に必須となり、有効です。 `period_unit=Month` の場合、有効な値は {1, 2, 3, 6, 12, 24, 36, 48, 60} です。	1
period_unit	string	任意	コントロールプレーンノードインスタンスの課金サイクルです。このパラメーターは、`charge_type` が `PrePaid` に設定されている場合にのみ有効です。 `Month`：月単位の課金。月単位の課金のみがサポートされています。	Month
auto_renew	boolean	任意	コントロールプレーンノードインスタンスの自動更新を有効にするかどうかを指定します。このパラメーターは、`charge_type` が `PrePaid` に設定されている場合にのみ有効です。有効な値は次のとおりです。 `true`：自動更新を有効にします。 `false`：自動更新を無効にします。デフォルト値：`false`。	false
auto_renew_period	integer	任意	コントロールプレーンノードインスタンスの自動更新期間です。有効な値：{1, 2, 3, 6, 12}。単位：月。デフォルト値：1。	1
instance_types	array	任意	インスタンスタイプです。詳細については、「インスタンスファミリー」をご参照ください。
	string	任意	インスタンスタイプです。	ecs.g6.large
image_type	string	任意	オペレーティングシステムのイメージタイプです。有効な値は次のとおりです。 `AliyunLinux3`：Alinux3 イメージ。 `Custom`：カスタムイメージ。	AliyunLinux3
image_id	string	任意	カスタムイメージの ID です。カスタムイメージを使用する場合は、このパラメーターを指定します。	aliyun_3_x64_20G_alibase_20240819.vhd
key_pair	string	任意	キーペア名です。このパラメーターまたは `login_password` のいずれかを指定します。	ack
login_password	string	任意	SSH ログオンパスワードです。このパラメーターまたは `key_pair` のいずれかを指定します。パスワードは 8～30 文字の長さで、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含める必要があります。パスワードベースのログオンを使用するには、スケールアウト時にこのパラメーターを指定します。	Ack@2000.
system_disk_category	string	任意	ノードのシステムディスクタイプです。有効な値は次のとおりです。 `cloud_efficiency`：Ultra Disk。 `cloud_ssd`：標準 SSD。 `cloud_essd`：ESSD。 `cloud_auto`：ESSD AutoPL。 `cloud_essd_entry`：ESSD Entry。	cloud_essd
system_disk_size	integer	任意	ノードのシステムディスクサイズです。有効な値の範囲：[40, 500]。単位：GiB。	120
system_disk_snapshot_policy_id	string	任意	ノードのシステムディスクの自動スナップショットポリシー ID です。	sp-2zej1nogjvovnz4z****
system_disk_performance_level	string	任意	ノードのシステムディスクのパフォーマンスレベルです。このパラメーターは ESSD にのみ適用されます。パフォーマンスレベルはディスクサイズによって決まります。詳細については、「ESSD」をご参照ください。	PL1
system_disk_provisioned_iops	integer	任意	ノードのシステムディスク用にプロビジョニングされた読み取り/書き込み IOPS です。有効な値の範囲：0～min{50,000, 1000 × 容量 - ベースラインパフォーマンス}。ベースラインパフォーマンス = min{1,800 + 50 × 容量, 50,000}。 `system_disk_category` が `cloud_auto` に設定されている場合にのみ、このパラメーターを設定できます。詳細については、「ESSD AutoPL」をご参照ください。	1000
system_disk_bursting_enabled	boolean	任意	ノードのシステムディスクのパフォーマンスバーストを有効にするかどうかを指定します。有効な値は次のとおりです。 `true`：パフォーマンスバーストを有効にします。 `false`：パフォーマンスバーストを無効にします。 `system_disk_category` が `cloud_auto` に設定されている場合にのみ、このパラメーターを設定できます。詳細については、「ESSD AutoPL」をご参照ください。	true
deploymentset_id	string	任意	デプロイメントセット ID です。	ds-bp10b35imuam5amw****
cloud_monitor_flags	boolean	任意	コントロールプレーンノードに CloudMonitor エージェントをインストールするかどうかを指定します。有効な値は次のとおりです。 `true`：CloudMonitor エージェントをインストールします。 `false`：CloudMonitor エージェントをインストールしません。	true
soc_enabled	boolean	任意	MLPS 2.0 セキュリティ強化。詳細については、「ACK の MLPS 2.0 セキュリティ強化を使用する」をご参照ください。有効な値は次のとおりです。 `true`：MLPS 2.0 セキュリティ強化を有効にします。 `false`：MLPS 2.0 セキュリティ強化を無効にします。デフォルト値：`false`。	false
security_hardening_os	boolean	任意	Alibaba Cloud OS セキュリティ強化。有効な値は次のとおりです。 `true`：Alibaba Cloud OS セキュリティ強化を有効にします。 `false`：Alibaba Cloud OS セキュリティ強化を無効にします。デフォルト値：`false`。	false
cpu_policy	string	任意	ノードの CPU 管理ポリシーです。バージョン 1.12.6 以降のクラスターは、次のポリシーに対応しています。 `static`：特定のリソース特性を持つ Pod のノード上の CPU アフィニティと排他性を強化します。 `none`：デフォルトの CPU アフィニティスキームを使用します。デフォルト値：`none`。	none
runtime	string	任意	コンテナランタイムです。有効な値は次のとおりです。 `containerd`：推奨。すべてのクラスターバージョンでサポートされています。デフォルト値：containerd。	containerd
node_port_range	string	任意	ポート範囲：30000～65535。デフォルト値：30000～32767。	30000-32767
size	integer	任意	コントロールプレーンノードの数です。専用クラスターのコントロールプレーンをスケールアウトするには、このパラメーターをターゲットのコントロールプレーンノード数に設定します。現在のノード数より大きい値を指定する必要があります。	5
security_group_id	string	任意	コントロールプレーンのセキュリティグループ ID です。セキュリティグループでブロッキングルールを設定する場合、そのルールでクラスターに必要なプロトコルとポートが許可されていることを確認してください。推奨されるセキュリティグループのルールについては、「クラスターセキュリティグループの設定と管理」をご参照ください。非専用 ACK クラスターの場合、コントロールプレーンとインストールされているマネージドコンポーネント (terway-controlplane など) は、更新中に短時間再起動します。この操作はオフピーク時に実行してください。コントロールプレーンのセキュリティグループを変更すると、コントロールプレーンとマネージドコンポーネントが使用する ENI は自動的に新しいセキュリティグループに追加されます。 ACK 専用クラスターの場合、新しくスケールアウトされたコントロールプレーンノードは自動的に新しいコントロールプレーンのセキュリティグループを適用します。既存のコントロールプレーンノードは影響を受けません。	sg-bp1h6rk3pgct2a08***
timezone	string	任意	クラスターのタイムゾーンです。詳細については、「サポートされているタイムゾーン」をご参照ください。タイムゾーンを変更すると、クラスター検査の設定には新しいタイムゾーンが適用されます。マネージドクラスターの場合、コントロールプレーンとインストールされているマネージドコンポーネント (terway-controlplane など) は、更新中に短時間再起動します。この操作はオフピーク時に実行してください。新しくスケールアウトされたノードは自動的に新しいタイムゾーンを適用します。既存のノードは影響を受けません。ノードプール内のノードをリセットして、既存のノードに新しいタイムゾーンを適用できます。専用クラスターの場合、新しくスケールアウトされたノード (コントロールプレーンノードを含む) は自動的に新しいタイムゾーンを適用します。既存のノード (コントロールプレーンノードを含む) は影響を受けません。ノードプール内のノードをリセットして、既存のノードに新しいタイムゾーンを適用できます。コントロールプレーンノードについては、スケールアウトしてからスケールインすることで、すべてのコントロールプレーンノードに新しいタイムゾーンを適用できます。	Asia/Shanghai
control_plane_endpoints_config	object	任意	クラスターの接続設定です。
internal_dns_config	object	任意	クラスターの内部ドメイン名設定です。この機能は ACK マネージドクラスターで利用できます。クラスターの内部ドメイン名を使用することで、kubelet や kube-proxy などのノード側システムコンポーネントが API サーバーにアクセスできるようになります。この機能が無効になっている場合、ノード側のシステムコンポーネントは CLB の IP アドレスを介して API サーバーにアクセスします。
bind_vpcs	array	任意	クラスターの内部ドメイン名解決が有効になる VPC です。
	string	任意	クラスターの内部ドメイン名解決が有効になる VPC です。	vpc-xxxx
enabled	boolean	任意	クラスターの内部ドメイン名アクセスを有効にするかどうかを指定します。有効な値は次のとおりです。 `true`：クラスターの内部ドメイン名アクセスを有効にします。ノード側のコンポーネント (kubelet、kube-proxy) は、クラスターの内部ドメイン名を介して API サーバーにアクセスします。	true
access_control_list `deprecated`	array	任意	登録済みクラスターの API サーバー SLB のアクセス制御リストです。
	string	任意	登録済みクラスターの API サーバー SLB のアクセス制御リストエントリです。注意：0.0.0.0/0 CIDR ブロックは指定しないでください。	192.168.XX.XX/24
instance_deletion_protection `deprecated`	boolean	任意	コンソールまたは API による意図しないノードのリリースを防ぐため、インスタンスの削除保護を有効または無効にします。有効な値は次のとおりです。 `true`：コンソールまたは API からの意図しないノードの削除を防ぎます。 `false`：コンソールまたは API からの意図しないノードの削除を許可します。デフォルト値：`false`。	false
ingress_domain_rebinding `deprecated`	boolean	任意	クラスターのテストドメイン名を再バインドするかどうかを指定します。有効な値は次のとおりです。 `true`：クラスターのテストドメイン名を再バインドします。 `false`：クラスターのテストドメイン名を再バインドしません。デフォルト値：`false`。	false
ingress_loadbalancer_id `deprecated`	string	任意	変更対象クラスターの SLB インスタンス ID です。	lb-wz97kes8tnndkpodw****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス本文です。
cluster_id	string	クラスター ID です。	cb95aa626a47740afbf6aa09****
request_id	string	リクエスト ID です。	687C5BAA-D103-4993-884B-C35E4314****
task_id	string	タスク ID です。	T-5a54309c80282e39ea00****

例

成功レスポンス

JSONJSON

{
  "cluster_id": "cb95aa626a47740afbf6aa09****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****",
  "task_id": "T-5a54309c80282e39ea00****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。