CreateClusterNodePool API による ENS ノードプールのプロビジョニング - ENS - Alibaba Cloud - ENS

ノードプールは、同一のプロパティを持つノードを論理的にグループ化したものです。これにより、ノードのアップグレードやオートスケーリングなどの一元管理と操作が可能になります。また、ノードプールの自動化機能により、運用コストも削減されます。たとえば、OS の CVE 脆弱性の自動修復、障害発生ノードの自動回復、kubelet および containerd の自動アップグレードなどが実現可能です。ノードプールを作成するには、CreateClusterNodePool を呼び出します。

操作説明

単一ユーザーの呼び出しレート：10 回/秒。
クラスターの作成は非同期操作です。API 呼び出しが完了した後、クラスターの初期化には 10～20 分程度かかります。この処理中は、DescribeClustersV1 を呼び出してクラスターの作成ステータスをクエリできます。クラスターの作成が完了したら、DescribeClusterUserKubeconfig を呼び出してクラスター証明書を取得してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:CreateClusterNodePool

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID。	eck-xxxxxxxx
NodepoolInfo	object	必須	ノードプールの構成。
Name	string	必須	ノードプールの名前。	test1
ScalingGroup	object	必須	スケーリンググループの構成。
DesiredSize	integer	任意	ノードプール内のインスタンス数（目標値）。	3
KeyPairName	string	任意	インスタンスに使用するキーペアの名前。このパラメーターまたは `Password` のいずれかを指定する必要があります。	key-pair-name
VswitchIds	array	必須	インスタンスで使用する vSwitch の ID。
	string	任意	クラスターノード用の vSwitch の ID。`ens_region_id` で指定された ENS リージョン内にある必要があります。	vsw-58eu2p6v64qw8ihhit1wz7wgv
InstanceChargeType	string	任意	インスタンスの課金方法。	PostPaid
InstanceTypes	array	必須	ノードプールのインスタンスタイプ。
	string	任意	インスタンスタイプ。	ens.sn1.small
SystemDiskCategory	string	任意	システムディスクのカテゴリ。有効な値： `local_ssd`、`local_hdd`、`cloud_efficiency`、`cloud_ssd`。	cloud_efficiency
SystemDiskSize	integer	任意	システムディスクのサイズ（GB 単位）。最小値は 20 GB で、10 の倍数である必要があります。	80
ImageId	string	必須	インスタンスに使用するイメージの ID。	m-6734fzvcwcv2o8jj201cpa7ox
DataDisks	array<object>	任意	インスタンスにアタッチするデータディスク。
	object	任意	データディスクの構成。
Category	string	任意	データディスクのカテゴリ。	cloud_efficiency
Size	integer	任意	データディスクのサイズ（GB 単位）。最小値は 20 GB で、10 の倍数である必要があります。	80
Password	string	任意	ノードプール内のインスタンスのパスワード。このパラメーターまたは `KeyPairName` のいずれかを指定する必要があります。	some-test-password
KubernetesConfig	object	任意	Kubernetes 構成。
PreUserData	string	任意	インスタンスが作成された直後に、クラスターに参加する前に実行される Base64 エンコード済みスクリプト。	ZWNobyBvawo=
UserData	string	任意	インスタンスがクラスターに参加した後に実行される Base64 エンコード済みスクリプト。	ZWNobyBvawo=

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
Nodepool	object	ノードプールの構成。
ClusterId	string	クラスター ID。	eck-d2666c5f
NodepoolInfo	object	ノードプールに関する情報。
Name	string	ノードプールの名前。	test1
EnsRegionId	string	クラスターが配置されている ENS リージョンの ID。	cn-guiyang-14
NodepoolId	string	ノードプールの ID。	np1176939548ac49e59febe82dcbf1ad56
ScalingGroup	object	関連付けられたスケーリンググループの構成。説明スケーリンググループは指定されたリソースグループに割り当てられます。作成時にリソースグループが指定されていない場合は、デフォルトのリソースグループが使用されます。
VswitchIds	array	クラスターノード用の vSwitch の ID。
	string	vSwitch の ID。	vsw-58eu2p6v64qw8ihhit1wz7wgv
DataDisks	array<object>	ノード用データディスクに関する情報。
	object	データディスクに関する情報。
Category	string	データディスクのカテゴリ。	cloud_efficiency
Size	integer	データディスクのサイズ（GB 単位）。	80
InstanceChargeType	string	インスタンスの課金方法。	PrePaid
InstanceTypes	array	ノードプール内のノードのインスタンスタイプ。
	string	インスタンスタイプ。	ens.sn1.small
SystemDiskCategory	string	システムディスクのカテゴリ。	cloud_efficiency
SystemDiskSize	integer	システムディスクのサイズ（GB 単位）。	80
ImageId	string	ノードに使用するイメージの ID。	m-67bdk1kpu1ylmt7k33h5dbiov
KeyPairName	string	キーペアの名前。	key-pair-name
Password	string	インスタンスのログインパスワード。	**********
KubernetesConfig	object	Kubernetes 関連の構成。
PreUserData	string	インスタンスが作成された直後に、ノードがクラスターに参加する前に実行される Base64 エンコード済みスクリプト。	ZWNobyBvawo=
UserData	string	ノードがクラスターに参加した後に実行される Base64 エンコード済みスクリプト。	ZWNobyBvawo=
Status	object	ノードプールのステータス。
State	string	ノードプールの状態。有効な値： `active`：ノードプールがアクティブな状態。 `scaling`：ノードプールがスケーリングアウト中。 `removing_nodes`：ノードプールがスケーリングイン中。	active
TotalNodes	integer	ノードプール内のインスタンス総数。作成中のインスタンス、サービス中のインスタンス、削除中のインスタンスを含みます。	10
DesiredNodes	integer	目標インスタンス数。	10
ServingNodes	integer	サービス中のインスタンス数。	10
InitialNodes	integer	作成中のインスタンス数。	0
RemovingNodes	integer	削除中のインスタンス数。	0
FailedNodes	integer	失敗したインスタンス数。	0
RequestId	string	リクエスト ID。	C0003E8B-B930-4F59-ADC0-0E209A9012A8

例

成功レスポンス

JSONJSON

{
  "Nodepool": {
    "ClusterId": "eck-d2666c5f",
    "NodepoolInfo": {
      "Name": "test1",
      "EnsRegionId": "cn-guiyang-14",
      "NodepoolId": "np1176939548ac49e59febe82dcbf1ad56"
    },
    "ScalingGroup": {
      "VswitchIds": [
        "vsw-58eu2p6v64qw8ihhit1wz7wgv"
      ],
      "DataDisks": [
        {
          "Category": "cloud_efficiency",
          "Size": 80
        }
      ],
      "InstanceChargeType": "PrePaid",
      "InstanceTypes": [
        "ens.sn1.small"
      ],
      "SystemDiskCategory": "cloud_efficiency",
      "SystemDiskSize": 80,
      "ImageId": "m-67bdk1kpu1ylmt7k33h5dbiov",
      "KeyPairName": "key-pair-name",
      "Password": "**********"
    },
    "KubernetesConfig": {
      "PreUserData": "ZWNobyBvawo=",
      "UserData": "ZWNobyBvawo="
    },
    "Status": {
      "State": "active",
      "TotalNodes": 10,
      "DesiredNodes": 10,
      "ServingNodes": 10,
      "InitialNodes": 0,
      "RemovingNodes": 0,
      "FailedNodes": 0
    }
  },
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8"
}

エラーコード

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

変更履歴

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