ACK クラスターの構成を変更します。
操作説明
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:ModifyCluster |
update |
*Cluster
|
|
なし |
リクエスト構文
PUT /api/v2/clusters/{ClusterId} HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClusterId |
string |
必須 |
クラスターの ID。 |
cb95aa626a47740afbf6aa099b65**** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディのパラメーター。 |
true |
access_control_list
deprecated
|
array |
任意 |
登録済みクラスターの API サーバーのロードバランサー (SLB) インスタンスのアクセス制御リスト (ACL)。 |
|
|
string |
任意 |
登録済みクラスターの API サーバーの SLB インスタンスのアクセス制御リスト (ACL)。 注意: 0.0.0.0/0 CIDR ブロックは指定できません。 |
192.168.XX.XX/24 |
|
| api_server_custom_cert_sans |
object |
任意 |
カスタム API サーバー証明書の Subject Alternative Name (SAN)。このパラメーターは、クライアントのアクセス制御のために、クラスター API サーバー証明書の SAN フィールドにカスタム IP アドレスまたはドメイン名を追加します。 このパラメーターはマネージドクラスターでのみサポートされます。 |
|
| action |
string |
任意 |
SAN 構成を上書きするか追加するかを指定します。有効な値:
|
append |
| subject_alternative_names |
array |
任意 |
SAN のリスト。 |
|
|
string |
任意 |
SAN。カスタム IP アドレスまたはドメイン名がサポートされています。複数の IP アドレスまたはドメイン名はコンマ (,) で区切ります。 |
aliyun.xxx.com,192.168.xx.xx |
|
| api_server_eip |
boolean |
任意 |
API サーバーへのパブリックネットワークアクセス用にクラスターに EIP をアタッチするかどうかを指定します。有効な値:
|
true |
| api_server_eip_id |
string |
任意 |
クラスター API サーバーにアタッチされている EIP のインスタンス ID。このパラメーターは、api_server_eip が true に設定されている場合にのみ有効です。 |
eip-wz9fnasl6dsfhmvci**** |
| client_token |
string |
任意 |
クライアントトークン。 |
af31042c-6355-495b-b6e3-exxb9669 |
| cluster_name |
string |
任意 |
カスタムクラスター名。名前には数字、漢字、英字、およびハイフン (-) を使用できます。名前の長さは 1~63 文字で、ハイフン (-) で始めることはできません。 |
cluster-new-name |
| cluster_spec |
string |
任意 |
cluster_type が ManagedKubernetes に設定され、プロファイルが構成されている場合のクラスタースペック。有効な値:
プロ版 XL、プロ版 2XL、およびプロ版 4XL は、コンテナサービス ACK Pro Provisioned Control Plane が提供する 3 つのティアです。コントロールプレーンリソースを事前割り当ておよび専有化することで、これらのティアは API の同時実行数と Pod のスケジューリング機能を常に高いレベルに維持します。AI トレーニングおよび推論、超大規模クラスター、および重大なワークロードに適しています。 プロ版およびプロビジョニング済みコントロールプレーンプロダクトのクラスター管理料金の詳細については、クラスター管理料金をご参照ください。 |
ack.pro.small |
| control_plane_config |
object |
任意 |
専用クラスターのコントロールプレーン構成。 |
|
| auto_renew |
boolean |
任意 |
コントロールプレーンノードインスタンスの自動更新を有効にするかどうかを指定します。このパラメーターは、charge_type が PrePaid に設定されている場合にのみ有効です。有効な値:
デフォルト値: false。 |
false |
| auto_renew_period |
integer |
任意 |
コントロールプレーンノードインスタンスの各更新時の自動更新期間。 有効な値: {1, 2, 3, 6, 12}。単位: 月。 デフォルト値: 1。 |
1 |
| charge_type |
string |
任意 |
コントロールプレーンノードインスタンスの課金方法。有効な値:
デフォルト値: PostPaid。 |
PostPaid |
| cloud_monitor_flags |
boolean |
任意 |
コントロールプレーンノードに CloudMonitor エージェントをインストールするかどうかを指定します。有効な値:
|
true |
| cpu_policy |
string |
任意 |
ノードの CPU 管理ポリシー。バージョン 1.12.6 以降のクラスターでは、以下のポリシーがサポートされています。
デフォルト値: none。 |
none |
| deploymentset_id |
string |
任意 |
デプロイメントセットの ID。 |
ds-bp10b35imuam5amw**** |
| image_id |
string |
任意 |
カスタムイメージの ID。カスタムイメージを使用する場合にこのパラメーターを指定します。 |
aliyun_3_x64_20G_alibase_20240819.vhd |
| image_type |
string |
任意 |
オペレーティングシステムイメージのタイプ。有効な値:
|
AliyunLinux3 |
| instance_types |
array |
任意 |
インスタンスタイプ。詳細については、「インスタンスファミリー」をご参照ください。 |
|
|
string |
任意 |
インスタンスタイプ。 |
ecs.g6.large |
|
| key_pair |
string |
任意 |
キーペア名。このパラメーターまたは login_password のいずれかを指定します。 |
ack |
| login_password |
string |
任意 |
SSH ログインパスワード。このパラメーターまたは key_pair のいずれかを指定します。パスワードの長さは 8~30 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含む必要があります。パスワードベースのログインを使用するには、スケールアウト時にこのパラメーターを指定します。 |
Ack@2000 |
| node_port_range |
string |
任意 |
ノードサービスポートのポート範囲。有効なポート範囲: [30000, 65535]。 デフォルト値: 30000-32767。 |
30000-32767 |
| 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 |
| runtime |
string |
任意 |
コンテナランタイム名。有効な値:
デフォルト値: containerd。 |
containerd |
| security_hardening_os |
boolean |
任意 |
Alibaba Cloud OS のセキュリティ強化を有効にするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| size |
integer |
任意 |
コントロールプレーンノードの数。専用クラスターのコントロールプレーンをスケールアウトするには、このパラメーターをターゲットのコントロールプレーンノード数に設定します。この数は、現在のコントロールプレーンノード数より大きい必要があります。 |
5 |
| soc_enabled |
boolean |
任意 |
MLPS 2.0 セキュリティ強化を有効にするかどうかを指定します。詳細については、「ACK MLPS 2.0 セキュリティ強化」をご参照ください。 有効な値:
デフォルト値: false。 |
false |
| system_disk_bursting_enabled |
boolean |
任意 |
ノードシステムクラウドディスクのバーストモードを有効にするかどうかを指定します。有効な値:
このパラメーターは、system_disk_category が cloud_auto に設定されている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」をご参照ください。 |
true |
| system_disk_category |
string |
任意 |
ノードシステムクラウドディスクのタイプ。有効な値:
|
cloud_essd |
| system_disk_performance_level |
string |
任意 |
ノードシステムクラウドディスクのパフォーマンスレベル。このパラメーターは ESSD クラウドディスクに対してのみ有効です。パフォーマンスレベルはクラウドディスクのサイズによって異なります。詳細については、「ESSD クラウドディスク」をご参照ください。 |
PL1 |
| system_disk_provisioned_iops |
integer |
任意 |
ノードシステムクラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。有効な値: 0 ~ min{50,000, 1000 × capacity - baseline performance}。ベースラインパフォーマンス = min{1,800 + 50 × capacity, 50,000}。 このパラメーターは、system_disk_category が cloud_auto に設定されている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」をご参照ください。 |
1000 |
| system_disk_size |
integer |
任意 |
ノードのシステムクラウドディスクのサイズ。有効な値: 40 ~ 500。単位: GiB。 |
120 |
| system_disk_snapshot_policy_id |
string |
任意 |
ノードのシステムクラウドディスクで使用される自動スナップショットポリシーの ID。 |
sp-2zej1nogjvovnz4z**** |
| 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 |
| load_balancers_config |
array<object> |
任意 |
クラスターアクセスの負荷分散構成。 |
|
|
object |
任意 |
クラスターアクセスの負荷分散構成。 |
||
| endpoint_type |
string |
任意 |
エンドポイントタイプ。 |
public |
| load_balancer_id |
string |
任意 |
エンドポイントに関連付けられた SLB インスタンス。 |
nlb-xxxx |
| deletion_protection |
boolean |
任意 |
クラスターの削除保護を有効にするかどうかを指定します。削除保護は、コンソールまたは API 操作の呼び出しによるクラスターの誤削除を防ぎます。有効な値:
|
false |
| enable_rrsa |
boolean |
任意 |
RRSA 特徴を有効または無効にするかどうかを指定します。このパラメーターはマネージドクラスターでのみサポートされます。有効な値:
|
true |
ingress_domain_rebinding
deprecated
|
boolean |
任意 |
クラスターのテストドメイン名を再バインドするかどうかを指定します。有効な値:
|
false |
ingress_loadbalancer_id
deprecated
|
string |
任意 |
クラスターの Ingress 用 SLB インスタンスの ID。 |
lb-wz97kes8tnndkpodw**** |
instance_deletion_protection
deprecated
|
boolean |
任意 |
コンソールまたは API 操作の呼び出しによるノードの誤削除を防ぐために、インスタンスの削除保護を有効にするかどうかを指定します。有効な値:
|
false |
| maintenance_window | maintenance_window |
任意 |
クラスターの O&M ウィンドウ構成。この特徴は、コンテナサービス ACK Pro マネージドクラスターでのみ有効です。 |
|
| operation_policy |
object |
任意 |
クラスターの自動 O&M ポリシー。 |
|
| cluster_auto_upgrade |
object |
任意 |
クラスターの自動スペックアップ構成。 |
|
| channel |
string |
任意 |
クラスターの自動スペックアップの周波数。詳細については、「スペックアップ周波数」を参照してください。 有効な値:
|
パッチ |
| enabled |
boolean |
任意 |
クラスターの自動スペックアップを有効にするかどうかを指定します。
|
true |
| resource_group_id |
string |
任意 |
クラスターのリソースグループ ID。 |
rg-acfmyvw3wjm**** |
| security_group_id |
string |
任意 |
コントロールプレーンのセキュリティグループ ID。
|
sg-bp1h6rk3pgct2a08*** |
| system_events_logging |
object |
任意 |
システムイベントのストレージ構成。 |
|
| enabled |
boolean |
任意 |
システムイベントのストレージを有効にするかどうかを指定します。
|
true |
| logging_project |
string |
任意 |
システムイベントストレージ用のログプロジェクトの名前。 |
k8s-log-cb95aa626a47740afbf6aa099b65**** |
| timezone |
string |
任意 |
クラスターのタイムゾーン。「サポートされているタイムゾーン」を参照してください。
|
Asia/Shanghai |
| vswitch_ids |
array |
任意 |
クラスターのコントロールプレーン vSwitch。専用クラスターの場合、変更イベントは新しくスケールアウトされたコントロールプレーンノードに適用されます。コンテナサービス ACK Pro マネージドクラスターのコントロールプレーン vSwitch を変更する場合は、次の点に注意してください。
|
|
|
string |
任意 |
クラスターのコントロールプレーン vSwitch。 |
vsw-2ze4jvvvade1yk899**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
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****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。