ModifyCluster を呼び出して、ACK クラスターの設定を変更します。
操作説明
instance_deletion_protection、ingress_loadbalancer_id、および access_control_list は無視されます。詳細については、「ACK クラスター管理における OpenAPI リクエスト・レスポンスパラメーターの変更および非推奨のお知らせ」をご参照ください。今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:ModifyCluster |
update |
*Cluster
|
|
なし |
リクエスト構文
PUT /api/v2/clusters/{ClusterId} HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClusterId |
string |
必須 |
クラスター ID。 |
cb95aa626a47740afbf6aa099b65**** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディのパラメーターです。 |
true |
| api_server_eip |
boolean |
任意 |
クラスターの API サーバーに EIP を関連付けてパブリックアクセスを許可するかどうかを指定します。有効な値:
|
true |
| api_server_eip_id |
string |
任意 |
クラスターの API サーバーに関連付けられている EIP インスタンスの ID。このパラメーターは、 |
eip-wz9fnasl6dsfhmvci**** |
| deletion_protection |
boolean |
任意 |
クラスターの削除保護を有効にするかどうかを指定します。有効な値:
デフォルト値: |
false |
| resource_group_id |
string |
任意 |
クラスターが属するリソースグループの ID。 |
rg-acfmyvw3wjm**** |
| maintenance_window | maintenance_window |
任意 |
クラスターのメンテナンスウィンドウ。この設定は、ACK Pro マネージドクラスターにのみ適用されます。 |
|
| enable_rrsa |
boolean |
任意 |
サービスアカウントの RAM ロール (RRSA) 機能を有効にするかどうかを指定します。この設定は、マネージドクラスターにのみ適用されます。有効な値:
|
true |
| cluster_name |
string |
任意 |
クラスターの名前。名前は 1~63 文字で、数字、文字、漢字、ハイフン (-) を使用できますが、ハイフンで始めることはできません。 |
cluster-new-name |
| cluster_spec |
string |
任意 |
クラスターの仕様。このパラメーターは、
Pro XL、Pro 2XL、Pro 4XL は、ACK Pro プロビジョニング済みコントロールプレーンによって提供される 3 つの仕様です。この機能は、コントロールプレーンリソースを事前に割り当てて固定することで、一貫して高いレベルの API 同時実行性と Pod のスケジューリング機能を確保します。これは、AI トレーニングと推論、大規模クラスター、およびミッションクリティカルなサービスに適しています。 Pro 版およびプロビジョニング済みコントロールプレーンクラスターのクラスター管理料金については、「クラスター管理料金」をご参照ください。 |
ack.pro.small |
| system_events_logging |
object |
任意 |
システムイベントを保存するための設定。 |
|
| enabled |
boolean |
任意 |
システムイベントロギングを有効にするかどうかを指定します。有効な値:
|
true |
| logging_project |
string |
任意 |
システムイベントを保存するための Log Service プロジェクトの名前。 |
k8s-log-cb95aa626a47740afbf6aa099b65**** |
| operation_policy |
object |
任意 |
クラスターの自動 O&M ポリシー。 |
|
| cluster_auto_upgrade |
object |
任意 |
クラスターの自動アップグレードポリシー。 |
|
| enabled |
boolean |
任意 |
クラスターの自動アップグレードを有効にするかどうかを指定します。有効な値:
|
true |
| channel |
string |
任意 |
自動アップグレードチャネル。詳細については、「アップグレードチャネル」をご参照ください。 有効な値:
|
patch |
| api_server_custom_cert_sans |
object |
任意 |
API サーバー証明書のカスタムサブジェクトの別名 (SAN)。このパラメーターを使用すると、クライアントアクセス制御のために、カスタム IP アドレスまたはドメイン名を API サーバー証明書の SAN フィールドに追加できます。 このパラメーターは、マネージドクラスターでのみ使用できます。 |
|
| action |
string |
任意 |
SAN の変更方法。有効な値:
|
append |
| subject_alternative_names |
array |
任意 |
SAN のリスト。 |
|
|
string |
任意 |
単一の SAN。IP アドレスまたはドメイン名を指定できます。 |
aliyun.xxx.com,192.168.xx.xx |
|
| vswitch_ids |
array |
任意 |
クラスターのコントロールプレーン用の VSwitch。専用クラスターでは、変更は新しく追加されたコントロールプレーンノードにのみ適用されます。マネージドクラスターでコントロールプレーンの VSwitch を変更する場合は、次の点に注意してください:
|
|
|
string |
任意 |
クラスターのコントロールプレーン用の VSwitch。 |
vsw-2ze4jvvvade1yk899**** |
|
| control_plane_config |
object |
任意 |
専用クラスターのコントロールプレーンの設定。 |
|
| charge_type |
string |
任意 |
コントロールプレーンノードの課金方法。有効な値:
デフォルト値: |
PostPaid |
| period |
integer |
任意 |
コントロールプレーンノードのサブスクリプション期間。このパラメーターは、
|
1 |
| period_unit |
string |
任意 |
コントロールプレーンノードの請求サイクル。このパラメーターは、
|
Month |
| auto_renew |
boolean |
任意 |
サブスクリプションのコントロールプレーンノードの自動更新を有効にするかどうかを指定します。このパラメーターは、
デフォルト値: |
false |
| auto_renew_period |
integer |
任意 |
コントロールプレーンノードの自動更新期間 (月単位)。 有効な値:1、2、3、6、12。 デフォルト値: |
1 |
| instance_types |
array |
任意 |
インスタンスタイプ。詳細については、「インスタンスタイプ」をご参照ください。 |
|
|
string |
任意 |
インスタンスタイプ。 |
ecs.g6.large |
|
| image_type |
string |
任意 |
OS イメージのタイプ。有効な値:
|
AliyunLinux3 |
| image_id |
string |
任意 |
カスタムイメージの ID。カスタムイメージを使用する場合は、このパラメーターを指定します。 |
aliyun_3_x64_20G_alibase_20240819.vhd |
| key_pair |
string |
任意 |
キーペアの名前。このパラメーターまたは |
ack |
| login_password |
string |
任意 |
SSH ログオンパスワード。このパラメーターまたは |
Ack@2000. |
| system_disk_category |
string |
任意 |
ノードのシステムディスクのタイプ。有効な値:
|
cloud_essd |
| system_disk_size |
integer |
任意 |
ノードのシステムディスクのサイズ (GiB)。値は 40~500 の範囲である必要があります。 |
120 |
| system_disk_snapshot_policy_id |
string |
任意 |
ノードのシステムディスクに適用する自動スナップショットポリシーの ID。 |
sp-2zej1nogjvovnz4z**** |
| system_disk_performance_level |
string |
任意 |
システムディスクのパフォーマンスレベル (PL)。このパラメーターは ESSD にのみ適用されます。PL はディスクサイズによって異なります。詳細については、「ESSD」をご参照ください。 |
PL1 |
| system_disk_provisioned_iops |
integer |
任意 |
ノードシステムディスクのプロビジョンド IOPS。有効な値:0~min{50,000, 1,000 × Capacity - Base IOPS}。Base IOPS = min{1,800 + 50 × Capacity, 50,000}。 このパラメーターは、 |
1000 |
| system_disk_bursting_enabled |
boolean |
任意 |
システムディスクのパフォーマンスバースト機能を有効にするかどうかを指定します。有効な値:
このパラメーターは、 |
true |
| deploymentset_id |
string |
任意 |
デプロイメントセットの ID。 |
ds-bp10b35imuam5amw**** |
| cloud_monitor_flags |
boolean |
任意 |
コントロールプレーンノードに CloudMonitor エージェントをインストールするかどうかを指定します。有効な値:
|
true |
| soc_enabled |
boolean |
任意 |
MLPS 準拠のセキュリティ強化を有効にするかどうかを指定します。詳細については、「ACK の MLPS 準拠のセキュリティ強化を有効にする」をご参照ください。 有効な値:
デフォルト値: |
false |
| security_hardening_os |
boolean |
任意 |
Alibaba Cloud OS Security Hardening を有効にするかどうかを指定します。有効な値:
デフォルト値: |
false |
| cpu_policy |
string |
任意 |
ノードの CPU 管理ポリシー。Kubernetes 1.12.6 以降のクラスターでは、次のポリシーがサポートされています:
デフォルト値: |
none |
| runtime |
string |
任意 |
コンテナランタイム。有効な値:
デフォルト値: |
containerd |
| node_port_range |
string |
任意 |
クラスターの NodePort 範囲。範囲は 30000~65535 である必要があります。 デフォルト値: |
30000-32767 |
| size |
integer |
任意 |
コントロールプレーンノードの数。専用クラスターのコントロールプレーンをスケールアウトするには、このパラメーターをターゲットのコントロールプレーンノード数に設定します。この数は現在の数より大きい必要があります。 |
5 |
| security_group_id |
string |
任意 |
コントロールプレーンのセキュリティグループの ID。
|
sg-bp1h6rk3pgct2a08*** |
| timezone |
string |
任意 |
クラスターのタイムゾーン。詳細については、「サポートされているタイムゾーン」をご参照ください。
|
Asia/Shanghai |
| control_plane_endpoints_config |
object |
任意 |
クラスター接続の設定。 |
|
| internal_dns_config |
object |
任意 |
クラスターの内部 DNS 設定。このパラメーターは ACK マネージドクラスターにのみ適用されます。kubelet や kube-proxy などのノード側のシステムコンポーネントは、クラスターの内部ドメインを使用して API サーバーにアクセスします。この機能が無効になっている場合、SLB の IP アドレスを使用して API サーバーにアクセスします。 |
|
| bind_vpcs |
array |
任意 |
クラスターの内部ドメインレコードが有効になる VPC。 |
|
|
string |
任意 |
クラスターの内部ドメインレコードが有効になる VPC。 |
vpc-xxxx |
|
| enabled |
boolean |
任意 |
内部ドメイン経由でクラスターへのアクセスを有効にするかどうかを指定します。有効な値:
|
true |
access_control_list
deprecated
|
array |
任意 |
登録済みクラスターの API サーバー用 SLB インスタンスのアクセス制御リストです。 |
|
|
string |
任意 |
アクセス制御リストの CIDR ブロックです。 注:0.0.0.0/0 CIDR ブロックは指定しないでください。 |
192.168.XX.XX/24 |
|
instance_deletion_protection
deprecated
|
boolean |
任意 |
ノードの削除保護を有効にするかどうかを指定します。有効にすると、コンソールから、または API を呼び出してノードを解放することはできません。有効な値:
デフォルト値: |
false |
ingress_domain_rebinding
deprecated
|
boolean |
任意 |
クラスターのデフォルトの Ingress ドメイン名を再バインドするかどうかを指定します。有効な値:
デフォルト値: |
false |
ingress_loadbalancer_id
deprecated
|
string |
任意 |
クラスターの Ingress に使用される SLB インスタンスの ID です。 |
lb-wz97kes8tnndkpodw**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
変更リクエストで返されるデータ。 |
||
| cluster_id |
string |
クラスターの一意の識別子。 |
cb95aa626a47740afbf6aa09**** |
| request_id |
string |
リクエストの一意の識別子。トラブルシューティングの際は、この ID をサポートチケットに記載してください。 |
687C5BAA-D103-4993-884B-C35E4314**** |
| task_id |
string |
非同期変更タスクの一意の識別子。 |
T-5a54309c80282e39ea00**** |
例
成功レスポンス
JSONJSON
{
"cluster_id": "cb95aa626a47740afbf6aa09****",
"request_id": "687C5BAA-D103-4993-884B-C35E4314****",
"task_id": "T-5a54309c80282e39ea00****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。