クラスターのノードプールを作成します。ノードプールは、同じ属性を共有するノードの論理的なコレクションであり、ノードのアップグレードや弾力的スケーリングなどの統一された管理と運用が可能です。さらに、OS の CVE 脆弱性の自動パッチ適用、障害ノードの自動復旧、kubelet および containerd バージョンの自動アップグレードなど、ノードプールの自動化された O&M 機能を活用して、O&M コストを削減できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:CreateClusterNodePool |
create |
*Cluster
|
なし | なし |
リクエスト構文
POST /clusters/{ClusterId}/nodepools HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClusterId |
string |
必須 |
クラスターの ID。 |
c61da77e8bfbc4c4c999af2b51b65**** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディのパラメーター。 |
|
| nodepool_info |
object |
任意 |
ノードプールの構成。 |
|
| name |
string |
必須 |
ノードプールの名前。 |
nodepool-test |
| type |
string |
任意 |
ノードプールのタイプ。有効な値:
列挙値:
|
ess |
| resource_group_id |
string |
任意 |
ノードプールのリソースグループ ID。ノードプールによって作成されたインスタンスは、このリソースグループに属します。 リソースは 1 つのリソースグループにのみ属することができます。ビジネスシナリオに応じて、リソースグループをプロジェクト、アプリケーション、組織などの概念にマッピングできます。 |
rg-acfmyvw3wjmb**** |
| auto_scaling |
object |
任意 |
自動弾力的スケーリングの設定。 |
|
| enable |
boolean |
任意 |
自動スケーリングを有効にするかどうかを指定します。有効な値:
値が false の場合、 デフォルト値: |
false |
| type |
string |
任意 |
自動弾力的スケーリングのインスタンスタイプ。このパラメーターは
デフォルト値: 重要 このフィールドは、ノードプールの作成後に変更できません。 列挙値:
|
cpu |
| max_instances |
integer |
任意 |
ノードプールでスケーリング可能なインスタンスの最大数 (既存のインスタンスを除く)。このパラメーターは 有効な値: [min_instances, 2000]。デフォルト値: 0。 |
10 |
| min_instances |
integer |
任意 |
ノードプールでスケーリング可能なインスタンスの最小数 (既存のインスタンスを除く)。このパラメーターは 有効な値: [0, max_instances]。デフォルト値: 0。 説明
|
1 |
is_bond_eip
deprecated
|
boolean |
任意 |
[非推奨] このフィールドは非推奨です。代わりに internet_charge_type と internet_max_bandwidth_out を使用してください。 EIP を関連付けるかどうかを指定します。有効な値:
デフォルト値: |
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 のピーク帯域幅。単位: Mbit/s。 |
null |
| management |
object |
任意 |
マネージドノードプールの構成。 |
|
| enable |
boolean |
任意 |
ノードプールのマネージド機能を有効にするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| auto_repair |
boolean |
任意 |
ノードを自動的に修復するかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| auto_repair_policy |
object |
任意 |
自動ノード修復ポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| approval_required |
boolean |
任意 |
ノード修復に手動承認が必要かどうかを指定します。 |
|
| auto_vul_fix |
boolean |
任意 |
CVE 脆弱性を自動的に修復するかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| auto_vul_fix_policy |
object |
任意 |
自動 CVE 修復ポリシー。 |
|
| restart_node |
boolean |
任意 |
ノードの再起動を許可するかどうかを指定します。このパラメーターは
デフォルト値: |
false |
| vul_level |
string |
任意 |
自動修正が許可される脆弱性レベル (カンマ区切り)。例:
デフォルト値: |
asap,nntf |
| exclude_packages |
string |
任意 |
脆弱性修正中に除外するパッケージ。 デフォルト値: |
kernel |
| auto_upgrade |
boolean |
任意 |
ノードを自動的にアップグレードするかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| auto_upgrade_policy |
object |
任意 |
自動ノードアップグレードポリシー。 |
|
| auto_upgrade_kubelet |
boolean |
任意 |
kubelet の自動アップグレードを許可するかどうかを指定します。このパラメーターは
デフォルト値: |
true |
| auto_upgrade_runtime |
boolean |
任意 |
ランタイムの自動アップグレードを許可するかどうかを指定します。このパラメーターは
デフォルト値: |
false |
| auto_upgrade_os |
boolean |
任意 |
オペレーティングシステムの自動アップグレードを許可するかどうかを指定します。このパラメーターは
デフォルト値: |
false |
upgrade_config
deprecated
|
object |
任意 |
[非推奨] 代わりに上位レベルの 自動アップグレードの設定。このパラメーターは |
|
auto_upgrade
deprecated
|
boolean |
任意 |
[非推奨] 代わりに上位レベルの 自動アップグレードを有効にするかどうかを指定します。有効な値:
|
null |
| surge |
integer |
任意 |
追加ノードの数。このパラメーターまたは アップグレード中はノードが使用できなくなります。クラスターのワークロードを補うために、追加ノードを作成できます。 説明
追加ノードの数は、現在のノード数を超えないようにしてください。 |
0 |
| surge_percentage |
integer |
任意 |
追加ノードの割合。このパラメーターまたは 追加ノード数 = 追加ノードの割合 × ノード数。たとえば、追加ノードの割合が 50% に設定されており、既存のノードが 6 つある場合、追加ノード数 = 50% × 6 = 3 となります。 |
0 |
| max_unavailable |
integer |
任意 |
使用不可ノードの最大値。 有効な値: [1,1000]。 デフォルト値: 1。 |
1 |
| auto_fault_diagnosis |
boolean |
任意 |
||
| drift_enabled |
boolean |
任意 |
||
| scaling_group |
object |
任意 |
ノードプールのスケーリンググループ構成。 |
|
| vswitch_ids |
array |
必須 |
vSwitch ID のリスト。有効な値: [1,8]。 説明
高可用性を確保するために、異なるゾーンの vSwitch を選択してください。 |
|
|
string |
任意 |
vSwitch の ID。 |
vsw-wz9mfnhmssud6eicu**** |
|
| instance_types |
array |
必須 |
ノードプール内のノードのインスタンスタイプのリスト。ノードプールがスケールアウトする際、このリストから条件に合致するインスタンスタイプを選択してインスタンスを作成します。 サポートされるインスタンスタイプの数は 1 から 10 です。 説明
高可用性を確保するために、複数のインスタンスタイプを選択してください。 |
|
|
string |
任意 |
インスタンスタイプ。詳細については、「インスタンスファミリー」を参照してください。 |
ecs.d1ne.2xlarge |
|
| instance_charge_type |
string |
必須 |
ノードプール内のノードの課金方法。有効な値:
デフォルト値: 列挙値:
|
PostPaid |
| period |
integer |
任意 |
ノードプール内のインスタンスのサブスクリプション期間。このパラメーターは、
|
1 |
| period_unit |
string |
任意 |
ノードプール内のインスタンスの課金サイクル。このパラメーターは、
デフォルト値: |
Month |
| auto_renew |
boolean |
任意 |
ノードプール内のインスタンスの自動更新を有効にするかどうかを指定します。このパラメーターは、
デフォルト値: |
true |
| auto_renew_period |
integer |
任意 |
各自動更新サイクルの期間。有効な値:
デフォルト値: 1。 |
1 |
| spot_strategy |
string |
任意 |
スポットインスタンスの入札ポリシー。有効な値:
詳細については、「スポットインスタンス」を参照してください。 |
NoSpot |
| spot_price_limit |
array<object> |
任意 |
現在のスポットインスタンスタイプの値幅制限構成。 |
|
|
object |
任意 |
スポットインスタンスの値幅制限構成。インスタンスタイプごとに異なる値幅制限を設定できます。 |
||
| instance_type |
string |
任意 |
スポットインスタンスタイプ。 |
ecs.c6.large |
| price_limit |
string |
任意 |
インスタンスあたりの最大値価格。 単位: USD/時間。 |
0.39 |
| image_type |
string |
任意 |
オペレーティングシステムイメージのタイプ。有効な値:
|
AliyunLinux3 |
| image_id |
string |
任意 |
カスタムイメージの ID。デフォルトではシステム提供のイメージが使用されます。 |
aliyun_2_1903_x64_20G_alibase_20200529.vhd |
| system_disk_category |
string |
任意 |
ノードのシステムクラウドディスクのタイプ。有効な値:
デフォルト値: |
cloud_efficiency |
| system_disk_categories |
array |
任意 |
複数のシステムクラウドディスクタイプ。優先度の高いクラウドディスクタイプが利用できない場合、システムは自動的に次の優先度のクラウドディスクタイプを試行してシステムクラウドディスクを作成します。 |
|
|
string |
任意 |
ノードの複数のシステムクラウドディスクタイプ。 有効な値:
|
cloud_essd |
|
| system_disk_size |
integer |
任意 |
ノードのシステムクラウドディスクのサイズ。単位: GiB。 有効な値: [20,2048]。 |
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_bursting_enabled |
boolean |
任意 |
システムクラウドディスクのバースト (パフォーマンスバースト) を有効にするかどうかを指定します。有効な値:
このパラメーターは、 |
true |
| system_disk_provisioned_iops |
integer |
任意 |
システムクラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。 有効な値: 0~min{50,000, 1000*capacity-baseline performance}。ベースラインパフォーマンス=min{1,800+50*capacity, 50000}。 このパラメーターは、 |
1000 |
| data_disks |
array |
任意 |
ノードプール内のノードのデータクラウドディスク構成。 |
|
| data_disk |
任意 |
データクラウドディスクの構成。 |
||
| security_group_ids |
array |
任意 |
セキュリティグループ ID のリスト。 |
|
|
string |
任意 |
セキュリティグループ ID のリスト。 |
sg-wz9a8g2mt6x5ll****** |
|
| key_pair |
string |
任意 |
パスワードなしログイン用のキーペアの名前。 説明
ノードプールが ContainerOS オペレーティングシステムを使用している場合、 |
np-key-name |
| login_password |
string |
任意 |
SSH ログインパスワード。 |
**** |
| login_as_non_root |
boolean |
任意 |
非ルートユーザーとして ECS インスタンスにログインするかどうかを指定します。
|
true |
cis_enabled
deprecated
|
boolean |
任意 |
[非推奨] 代わりに security_hardening_os パラメーターを使用してください。 |
null |
| soc_enabled |
boolean |
任意 |
MLPS 2.0 セキュリティ強化を有効にするかどうかを指定します。この機能は、システムイメージが Alibaba Cloud Linux 2 または Alibaba Cloud Linux 3 の場合にのみ利用可能です。Alibaba Cloud は、Alibaba Cloud Linux 2 および Alibaba Cloud Linux 3 の MLPS 2.0 Level 3 イメージに対して、等級保護コンプライアンスベースラインチェック基準とスキャンプログラムを提供しています。 |
false |
| security_hardening_os |
boolean |
任意 |
Alibaba Cloud OS セキュリティ強化を有効にするかどうかを指定します。有効な値:
デフォルト値: |
false |
| internet_charge_type |
string |
任意 |
パブリック IP アドレスの課金方法。有効な値:
|
PayByTraffic |
| internet_max_bandwidth_out |
integer |
任意 |
ノードの最大アウトバウンドパブリック帯域幅。単位: Mbit/s。有効な値: [1,100]。 |
5 |
| tags |
array<object> |
任意 |
ECS インスタンスにのみ追加されるタグ。 タグキーは重複できず、最大長は 128 文字です。タグキーと値は "aliyun" または "acs:" で始まることや、"https://" または "http://" を含むことはできません。 |
|
|
object |
任意 |
ノードのタグ。 |
||
| key |
string |
任意 |
タグキー。 |
node-k-1 |
| value |
string |
任意 |
タグ値。 |
node-v-1 |
| desired_size |
integer |
任意 |
ノードプール内の希望ノード数。 ノードプールが維持すべきノードの総数。クラスターコンポーネントが正常に動作するように、少なくとも 2 つのノードを設定することを推奨します。希望ノード数を調整することで、ノードプールのスケールインまたはスケールアウトが可能です。 ノードを作成する必要がない場合は、この値を 0 に設定し、後で手動で調整してノードを追加してください。 |
0 |
| multi_az_policy |
string |
任意 |
マルチゾーンスケーリングポリシー。 |
COST_OPTIMIZED |
| scaling_policy |
string |
任意 |
スケーリンググループのパターン。有効な値:
デフォルト値: |
release |
| on_demand_base_capacity |
integer |
任意 |
スケーリンググループに必要な従量課金インスタンスの最小数。有効な値: [0,1000]。従量課金インスタンスの数がこの値未満の場合、従量課金インスタンスが優先度を持って作成されます。 |
0 |
| on_demand_percentage_above_base_capacity |
integer |
任意 |
従量課金インスタンスの最小数 ( |
20 |
| spot_instance_pools |
integer |
任意 |
利用可能なインスタンスタイプの数。スケーリンググループは、最もコストの低い複数のインスタンスタイプにわたってスポットインスタンスを作成します。有効な値: [1,10]。 |
5 |
| spot_instance_remedy |
boolean |
任意 |
スポットインスタンスの補充を有効にするかどうかを指定します。有効にすると、スケーリンググループは回収されようとしているスポットインスタンスを置き換えるために新しいインスタンスの作成を試みます。有効な値:
|
false |
| compensate_with_on_demand |
boolean |
任意 |
` |
true |
| deploymentset_id |
string |
任意 |
デプロイメントセットの ID。デプロイメントセットを使用して、ノードプールによってスケールアウトされた ECS インスタンスを異なる物理サーバーに分散配置し、高可用性と基盤となるディザスタリカバリを確保できます。デプロイメントセット内で ECS インスタンスが作成されると、事前設定されたデプロイ戦略に基づいて指定されたリージョンで起動されます。 重要 デプロイメントセットを選択すると、ノードプール内の最大ノード数が制限されます。デプロイメントセットでサポートされるデフォルトの最大ノード数は、20 × ゾーン数 (ゾーン数は vSwitch によって決定されます) です。慎重に選択し、ノードのスケールアウト失敗を |
ds-bp1d19mmbsv3jf6xxxxx |
| rds_instances |
array |
任意 |
RDS インスタンスのリスト。 |
|
|
string |
任意 |
RDS インスタンスの ID。 [parameters.1.schema |
rds-**** |
|
| private_pool_options |
object |
任意 |
The private node pool configuration. |
|
| id |
string |
任意 |
The private node pool ID. When |
eap-bp67acfmxazb4**** |
| match_criteria |
string |
任意 |
The private node pool type. Specifies the private pool capacity option for instance launch. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instance launch. Valid values:
|
Target |
security_group_id
deprecated
|
string |
任意 |
The security group ID of the node pool. Use either this parameter or |
sg-wz9a8g2mt6x5llu0**** |
platform
deprecated
|
string |
任意 |
[This field is deprecated] Use the The operating system distribution. Valid values:
Default value: |
null |
| instance_patterns |
array |
任意 |
The instance attribute configuration. |
|
| instance_patterns |
任意 |
The instance attributes. |
||
| ram_role_name |
string |
任意 |
The Worker RAM role name.
重要 Only ACK managed clusters of version 1.22 or later support this parameter. |
example-role |
| instance_metadata_options | InstanceMetadataOptions |
任意 |
The ECS instance metadata access configuration. |
|
| resource_pool_options |
object |
任意 |
The resource pool and resource pool strategy used when creating instances. Note the following when you set this parameter: This parameter takes effect only when creating pay-as-you-go instances. This parameter cannot be set together with private_pool_options.match_criteria or private_pool_options.id. |
|
| strategy |
string |
任意 |
The resource pool strategy used when creating instances. Resource pools include private pools generated after elasticity assurance or capacity reservation takes effect, and public pools for instance launch. Valid values: PrivatePoolFirst: Private pool first. When resouce_pool_options.private_pool_ids is specified, the specified private pools are used first. If no private pool is specified or the specified private pool capacity is insufficient, open-type private pools are automatically matched. If no matching private pool is available, public pool resources are used. PrivatePoolOnly: Private pool only. You must specify resouce_pool_options.private_pool_ids. If the specified private pool capacity is insufficient, instance launch fails. None: Do not use resource pool strategy. Default value: None. |
PrivatePoolFirst |
| private_pool_ids |
array |
任意 |
The list of private pool IDs, which are elasticity assurance IDs or capacity reservation IDs. Only Target mode private pool IDs can be specified. Valid values of N: 1 to 20. |
|
|
string |
任意 |
The private pool ID, which is the elasticity assurance ID or capacity reservation ID. Only Target mode private pool IDs can be specified. |
eap-bp67acfmxazb4**** |
|
| system_disk_snapshot_policy_id |
string |
任意 |
The system cloud disk snapshot policy. |
sp-0jl6xnmme8v7o935**** |
| disk_init |
array |
任意 |
The block device initialization configuration. |
|
|
DiskInit |
任意 |
The DiskInit configuration. |
||
| node_config |
object |
任意 |
The node configuration. |
|
| kubelet_configuration | kubelet_config |
任意 |
The Kubelet parameter settings. |
|
| kubernetes_config |
object |
任意 |
The cluster-related configuration. |
|
| labels |
array |
任意 |
The node labels. Adds labels to Kubernetes cluster nodes. |
|
| tag |
任意 |
The label configuration. |
||
| taints |
array |
任意 |
The taint configuration. |
|
| taint |
任意 |
The taint configuration set. |
||
| runtime |
string |
任意 |
The container runtime name. ACK supports the following three container runtimes:
Default value: containerd. |
containerd |
| runtime_version |
string |
任意 |
The container runtime version. |
1.6.38 |
| cpu_policy |
string |
任意 |
The node CPU management policy. The following two policies are supported for cluster versions 1.12.6 and later:
Default value: |
none |
| user_data |
string |
任意 |
The instance user data. After the node joins the cluster, the specified instance user data script is executed. For more information, see User-Data scripts. |
dGhpcyBpcyBhIGV4YW1wbGU= |
| unschedulable |
boolean |
任意 |
Specifies whether the scaled-out nodes are unschedulable.
|
true |
| cms_enabled |
boolean |
任意 |
Specifies whether to install CloudMonitor on ECS nodes. After installation, you can view monitoring information of the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. Valid values:
Default value: |
false |
| node_name_mode |
string |
任意 |
The custom node name. After you customize the node name, the node name, ECS instance name, and ECS instance hostname are all changed. 説明
For Windows instances with custom node names enabled, the hostname is fixed to the IP address with hyphens (-) replacing the dots (.) in the IP address, and does not include the prefix or suffix. The node name consists of a prefix, the node IP address, and a suffix:
For example, if the node IP address is 192.XX.YY.55, the prefix is aliyun.com, and the suffix is test:
|
aliyun.com192.XX.YY.55test |
| pre_user_data |
string |
任意 |
The instance pre-custom data. Before the node joins the cluster, the specified pre-custom data script is executed. For more information, see User-Data scripts. |
dGhpcyBpcyBhIGV4YW1wbGU |
| tee_config |
object |
任意 |
The confidential computing cluster configuration. |
|
| tee_enable |
boolean |
任意 |
Specifies whether to enable confidential computing for the cluster.
|
true |
interconnect_config
deprecated
|
object |
任意 |
[This field is deprecated] The edge node pool configuration. |
|
| cen_id |
string |
任意 |
[This field is deprecated] The Cloud Enterprise Network (CEN) instance ID bound to the enhanced edge node pool. |
null |
| ccn_id |
string |
任意 |
[This field is deprecated] The Cloud Connect Network (CCN) instance ID bound to the enhanced edge node pool. |
null |
| ccn_region_id |
string |
任意 |
[This field is deprecated] The region of the Cloud Connect Network instance bound to the enhanced edge node pool. |
null |
| bandwidth |
integer |
任意 |
[This field is deprecated] The network bandwidth of the enhanced edge node pool. Unit: Mbps. |
null |
| improved_period |
string |
任意 |
[This field is deprecated] The subscription duration of the enhanced edge node pool. Unit: months. |
null |
count
deprecated
|
integer |
任意 |
[This field is deprecated] Use desired_size instead. The number of nodes in the node pool. |
null |
max_nodes
deprecated
|
integer |
任意 |
[This field is deprecated] The maximum number of nodes allowed in the edge node pool. |
null |
| interconnect_mode |
string |
任意 |
The network type of the edge node pool. This parameter takes effect only for node pools with
|
basic |
| host_network |
boolean |
任意 |
Specifies whether the pod network mode uses host network mode.
|
true |
| intranet |
boolean |
任意 |
Specifies whether nodes in the edge node pool have Layer 3 network connectivity with each other.
|
true |
| eflo_node_group |
object |
任意 |
The Lingjun node pool configuration. |
|
| cluster_id |
string |
任意 |
The Lingjun cluster ID to associate when creating a Lingjun node pool. |
i1169130516633730**** |
| group_id |
string |
任意 |
The Lingjun group ID of the Lingjun cluster to associate when creating a Lingjun node pool. |
ng-ec3c96ff0aa**** |
| auto_attach_enabled |
boolean |
任意 |
||
| worker_ram_role_name |
string |
任意 |
||
| auto_mode |
object |
任意 |
The intelligent managed configuration for the node pool. |
|
| enable |
boolean |
任意 |
Specifies whether to enable intelligent managed mode. Valid values:
|
true |
| node_components |
array<object> |
任意 |
The list of node components. |
|
|
array<object> |
任意 |
The node component. |
||
| name |
string |
任意 |
The node component name. |
kubelet |
| version |
string |
任意 |
The node component version. |
1.33.3-aliyun.1 |
| config |
object |
任意 |
The node component configuration. |
|
| custom_config |
object |
任意 |
The custom configuration of the node component. |
{"cpuManagerPolicy":"static"} |
|
any |
任意 |
The custom configuration string of the node component. |
cpuManagerPolicy |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
The node pool configuration. |
||
| nodepool_id |
string |
The node pool ID. |
np31da1b38983f4511b490fc62108a**** |
| task_id |
string |
The task ID. |
T-613b19bbd160ad492800**** |
| request_id |
string |
The request ID. |
0527ac9a-c899-4341-a21a-**** |
例
成功レスポンス
JSONJSON
{
"nodepool_id": "np31da1b38983f4511b490fc62108a****",
"task_id": "T-613b19bbd160ad492800****",
"request_id": "0527ac9a-c899-4341-a21a-****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。