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

ModifyCluster API を呼び出して、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 Edition `ack.pro.xlarge`：Pro XL `ack.pro.2xlarge`：Pro 2XL `ack.pro.4xlarge`：Pro 4XL (このエディションは許可リストユーザーのみ利用可能です。) この機能は、コントロールプレーンリソースを事前に割り当て、一貫した高性能な API の同時実行と Pod のスケジューリングを保証します。AI ワークロード、超大規模クラスター、およびミッションクリティカルなアプリケーションに最適です。 Pro Edition およびプロビジョニングされたコントロールプレーンクラスターの管理料金の詳細については、「クラスター管理料金」をご参照ください。	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`：以前のマイナーバージョン。 `rapid`：最新のマイナーバージョン。	patch
api_server_custom_cert_sans	object	任意	API サーバー証明書のカスタムのサブジェクトの別名 (SAN) です。これにより、クライアントはカスタム IP アドレスまたはドメイン名を使用して API サーバーにアクセスできます。このパラメーターはマネージドクラスターでのみ利用可能です。
action	string	任意	SAN 設定に対して実行するアクションです。有効な値は次のとおりです。 `overwrite`：既存の SAN 設定を上書きします。 `append`：既存の SAN 設定に追加します。	append
subject_alternative_names	array	任意	SAN のリストです。
	string	任意	単一の SAN です。カスタム IP アドレスまたはドメイン名を指定できます。	aliyun.xxx.com,192.168.xx.xx
vswitch_ids	array	任意	コントロールプレーンの VSwitch です。専用クラスターの場合、この変更は新しく追加されたコントロールプレーンノードにのみ影響します。マネージドクラスターの VSwitch を変更する場合は、次の点に注意してください。このパラメーターは既存の VSwitch リストを上書きします。ターゲットの VSwitch の完全なリストを指定する必要があります。更新中にコントロールプレーンコンポーネントが短時間再起動します。この操作はオフピーク時間に実行することを推奨します。クラスター内のすべてのセキュリティグループ (コントロールプレーンのセキュリティグループ、すべてのノードプールのセキュリティグループ、およびコンテナネットワークで使用されるセキュリティグループを含む) のインバウンドおよびアウトバウンドルールが、新しい VSwitch の IP CIDR ブロックからのトラフィックを許可していることを確認してください。そうしないと、ノードとコンテナが API サーバーに接続できなくなる可能性があります。新しいコントロールプレーン VSwitch にアクセス制御リスト (ACL) を設定する場合、ACL がクラスターノードとコンテナネットワークの 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	任意	OS イメージのタイプです。有効な値は次のとおりです。 `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	任意	システムディスクのサイズです。単位：GiB。有効な値：40～500。	120
system_disk_snapshot_policy_id	string	任意	ノードのシステムディスクに使用される自動スナップショットポリシーの ID です。	sp-2zej1nogjvovnz4z****
system_disk_performance_level	string	任意	システムディスクのパフォーマンスレベルです。このパラメーターは ESSD でのみ利用可能です。パフォーマンスレベルはディスクサイズに関連しています。詳細については、「ESSD」をご参照ください。	PL1
system_disk_provisioned_iops	integer	任意	システムディスクのプロビジョンド Read/Write 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	任意	システムディスクのバーストを有効にするかどうかを指定します。有効な値は次のとおりです。 `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	任意	レベル 3 保護を有効にします。詳細については、「ACK クラスターのレベル 3 保護を有効にする」をご参照ください。有効な値は次のとおりです。 `true`：レベル 3 保護を有効にします。 `false`：レベル 3 保護を無効にします。デフォルト値：`false`。	false
security_hardening_os	boolean	任意	Alibaba Cloud OS Security Hardening を有効にするかどうかを指定します。有効な値は次のとおりです。 `true`：Alibaba Cloud OS Security Hardening を有効にします。 `false`：Alibaba Cloud OS Security Hardening を無効にします。デフォルト値：`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	任意	NodePort サービスのポート範囲です。有効範囲：30000～65535。デフォルト値：30000-32767。	30000-32767
size	integer	任意	コントロールプレーンノードの数です。専用クラスターのコントロールプレーンをスケールアウトするには、このパラメーターをターゲットノード数に設定します。現在のノード数より大きい値を指定する必要があります。	5
security_group_id	string	任意	コントロールプレーンのセキュリティグループの ID です。セキュリティグループでトラフィックをブロックするルールを設定する場合、クラスターが依存するポートとプロトコルのトラフィックを許可する必要があります。推奨されるセキュリティグループのルールの詳細については、「クラスターセキュリティグループの設定と管理」をご参照ください。専用 ACK クラスター以外のクラスターでは、更新中にコントロールプレーンと terway-controlplane などインストールされているマネージドコンポーネントが短時間再起動します。この操作はオフピーク時間に実行することを推奨します。コントロールプレーンのセキュリティグループが変更されると、コントロールプレーンとインストールされているマネージドコンポーネントが使用する Elastic Network Interface (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 インスタンスのアクセス制御リスト (ACL) です。
	string	任意	登録済みクラスターの API サーバー用 SLB インスタンスのアクセス制御リスト (ACL) です。注： 0.0.0.0/0 は指定しないでください。	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****"
}

エラーコード

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

変更履歴

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