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

既存の Elastic Compute Service (ECS) インスタンスを Container Service for Kubernetes (ACK) クラスターに追加します。ECS インスタンスをワーカーノードとして ACK クラスターに追加する必要がある場合、またはワーカーノードをクラスターに再追加する必要がある場合は、この操作を呼び出すことができます。

操作説明

この API を呼び出す前に、制限事項をよくお読みになり、追加する ECS インスタンスが条件を満たしていることを確認してください。

今すぐお試しください

この 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:AttachInstances

update

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし

リクエスト構文

POST /clusters/{ClusterId}/attach HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID。	c106f377e16f34eb1808d6b9362c9****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディパラメーター。
instances	array	必須	追加する ECS インスタンス。
	string	任意	ECS インスタンス ID。	i-2zed0sswuau6o89b****
key_pair	string	任意	ECS インスタンスへのログインに使用するキーペアの名前。このパラメーターまたは `login_password` を指定する必要があります。説明このパラメーターは、`nodepool_id` を指定した場合はサポートされません。	security-key
password	string	任意	ECS インスタンスへのログインに使用する SSH ログインパスワード。このパラメーターまたは `key_pair` を指定する必要があります。パスワードは 8～30 文字で、大文字、小文字、数字、特殊文字のうち、3 種類以上を含める必要があります。パスワードにバックスラッシュ (\) や二重引用符 (") を含めることはできません。パスワードは、セキュリティを確保するためにデータ転送中に暗号化されます。	Hello1234
format_disk	boolean	任意	コンテナデータとイメージをデータディスクに保存するかどうかを指定します。有効値： `true`：コンテナデータとイメージをデータディスクに保存します。 `false`：コンテナデータとイメージをデータディスクに保存しません。デフォルト値：`false`。データディスクのアタッチ方法： ECS インスタンスにデータディスクがすでにアタッチされていて、最後のデータディスクのファイルシステムが初期化されていない場合、システムはこのデータディスクを自動的に ext4 にフォーマットします。その後、システムはこのディスクを使用して、/var/lib/docker および /var/lib/kubelet ディレクトリにデータを保存します。 ECS インスタンスにデータディスクがアタッチされていない場合、システムは新しいデータディスクを購入しません。説明コンテナデータとイメージをデータディスクに保存することを選択し、データディスクがすでに ECS インスタンスにアタッチされている場合、このデータディスク上の元のデータはクリアされます。データ損失を防ぐために、ディスクをバックアップできます。	false
keep_instance_name	boolean	任意	インスタンス名を保持するかどうかを指定します。有効値： `true`：インスタンス名を保持します。 `false`：インスタンス名を保持しません。デフォルト値：`false`。	false
is_edge_worker	boolean	任意	追加するノードが Edge Node Service (ENS) ノードであるかどうかを指定します。有効値： `true`：追加するノードは ENS ノードです。 `false`：追加するノードは ENS ノードではありません。デフォルト値：`false`。説明追加するノードが ENS ノードの場合は、値を `true` に設定する必要があります。これにより、ノードを識別できます。	false
nodepool_id	string	任意	ノードが追加されるノードプールの ID。このパラメーターを指定しない場合、ノードはデフォルトのノードプールに追加されます。	np615c0e0966124216a0412e10afe0****
image_id	string	任意	カスタムイメージ ID。このパラメーターを指定しない場合、デフォルトのシステムイメージが使用されます。説明カスタムイメージを指定すると、そのカスタムイメージを使用してノードのシステムディスクにオペレーティングシステムがデプロイされます。このパラメーターは、`nodepool_id` を指定した場合はサポートされません。	aliyun_2_1903_x64_20G_alibase_20200529.vhd
cpu_policy	string	任意	ノードの CPU 管理ポリシー。クラスターの Kubernetes バージョンが 1.12.6 以降の場合、次のポリシーがサポートされます： `static`：ノード上の特定のリソース特性を持つ Pod に、強化された CPU アフィニティと排他性を付与できます。 `none`：デフォルトの CPU アフィニティを使用します。デフォルト値：`none` 説明このパラメーターは、`nodepool_id` を指定した場合はサポートされません。	none
user_data	string	任意	ノード上のユーザー定義データ。詳細については、「インスタンスの起動時にインスタンスユーザーデータを使用してコマンドまたはスクリプトを自動的に実行する」をご参照ください。説明このパラメーターは、`nodepool_id` を指定した場合はサポートされません。	IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi
rds_instances	array	任意	ApsaraDB RDS インスタンスのリスト。
	string	任意	ApsaraDB RDS インスタンス ID。説明このパラメーターは、`nodepool_id` を指定した場合はサポートされません。	rm-67yawhau****
runtime	runtime	任意	コンテナランタイム。説明このパラメーターは、`nodepool_id` を指定した場合はサポートされません。
tags	array	任意	ノードに追加するラベル。ノードにラベルを追加する場合、次のルールが適用されます：ラベルは、大文字と小文字を区別するキーと値のペアです。最大 20 個のラベルを追加できます。キーは一意である必要があり、長さは 64 文字を超えることはできません。値は空にでき、長さは 128 文字を超えることはできません。キーと値は、`aliyun`、`acs:`、`https://`、または `http://` で始めることはできません。詳細については、「ラベルとセレクター」をご参照ください。説明このパラメーターは、`nodepool_id` を指定した場合はサポートされません。
	tag	任意	ノードに追加するラベル。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
list	array<object>	追加されたノードの詳細。
	object
code	string	タスク結果を示すコード。	200
instanceId	string	ECS インスタンスの ID。	i-2ze0lgm3y6iylcbt****
message	string	ECS インスタンスが ACK クラスターに正常に追加されたかどうかを示します。	successful
task_id	string	タスク ID。	T-5a544aff80282e39ea00****

例

成功レスポンス

JSONJSON

{
  "list": [
    {
      "code": "200",
      "instanceId": "i-2ze0lgm3y6iylcbt****",
      "message": "successful"
    }
  ],
  "task_id": "T-5a544aff80282e39ea00****"
}

エラーコード

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

変更履歴

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