AttachInstances - 添加已有ECS執行個體到叢集 - Container Service for Kubernetes

如果購買ECS執行個體後需要將該雲端服務器添加到ACK叢集中作為Worker節點，或移除Worker節點後需將節點執行個體重新加入節點池，您可以調用AttachInstances介面，將已有ECS執行個體添加到ACK叢集。

介面說明

調用本介面前，請仔細閱讀使用限制，確保待添加的 ECS 執行個體滿足條件。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	否	待添加執行個體的金鑰組名稱。 key_pair 和 password 參數若要填寫時，只需填寫其中一個即可，或者兩個參數均不填寫。說明指定`nodepool_id`後，該參數不支援。	security-key
password	string	否	待添加執行個體的 SSH 登入密碼。key_pair 和 password 參數若要填寫時，只需填寫其中一個即可，或者兩個參數均不填寫。密碼填寫規範如下：長度為 8~30 個字元至少同時包含大小寫字母、數字和特殊符號不支援反斜線（\）和半形雙引號（"）兩個符號出於安全性考慮，密碼傳輸過程中都會進行加密處理。	Hello1234
format_disk	boolean	否	是否將容器資料和鏡像儲存在資料盤中。取值如下： `true`：將容器資料和鏡像儲存在資料盤。 `false`：不將容器資料和鏡像儲存在資料盤。預設值：`false`。資料盤掛載規則：如果 ECS 已掛載資料盤，且最後一塊資料盤的檔案系統未初始化，系統會自動將該資料盤格式化為 EXT4，用來存放內容/var/lib/docker、/var/lib/kubelet（分別為 Docker 容器運行時和 kubelet 組件預設對應的資料目錄）。如果 ECS 未掛載資料盤，則不會掛載新的資料盤。說明當選擇將資料存放區至資料盤並且 ECS 已掛載資料盤，資料盤內原有資料將丟失，請注意備份資料。	false
keep_instance_name	boolean	否	是否保留原執行個體名稱。取值如下： `true`：保留執行個體名稱。 `false`：不保留執行個體名稱。預設值：`false`。	false
is_edge_worker	boolean	否	待添加的節點是否為邊緣節點，即 ENS 節點。取值： `true`：表示添加的節點是邊緣節點。 `false`：表示添加的節點是不是邊緣節點。預設值：`false`。說明如果是邊緣節點，取值必須是`true`，用於標識該節點類型為 ENS 節點。	false
nodepool_id	string	否	節點池 ID。如果不指定，則將節點添加到預設節點池中。	np615c0e0966124216a0412e10afe0****
image_id	string	否	自訂鏡像 ID。如果指定自訂鏡像 ID，執行個體系統硬碟鏡像將被替換為該自訂鏡像。如果不指定，則使用預設系統鏡像。說明指定`nodepool_id`後，該參數不支援。	aliyun_2_1903_x64_20G_alibase_20200529.vhd
cpu_policy	string	否	節點 CPU 管理原則。當叢集版本在 1.12.6 及以上時支援以下兩種策略： `static`：允許為節點上具有某些資源特徵 Pod 增強其 CPU 親和性和獨佔性。 `none`：表示啟用現有的預設 CPU 親和性方案。預設值：`none`。說明指定`nodepool_id`後，該參數不支援。	none
user_data	string	否	節點自訂資料。具體詳情，請參見產生執行個體自訂資料。說明指定`nodepool_id`後，該參數不支援。	IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi
rds_instances	array	否	RDS 執行個體列表。
	string	否	RDS 執行個體 ID。說明指定`nodepool_id`後，該參數不支援。	rm-67yawhau****
runtime	runtime	否	容器運行時。說明指定`nodepool_id`後，該參數不支援。 name：容器運行時名稱，ACK 支援以下三種容器運行時。 containerd：推薦使用，支援所有叢集版本。 Sandboxed-Container.runv：安全沙箱容器，提供更高的隔離性，支援 1.24 版本及以下叢集。 docker：支援 1.22 版本及以下叢集。預設值：containerd。 containerd：容器運行時版本，預設為最新版。關於安全沙箱運行時的變更詳情，請參見安全沙箱運行時變更記錄。
tags	array	否	節點標籤。標籤定義規則：標籤由區分大小寫索引值對（key-value）組成，您最多可以設定 20 個標籤。標籤鍵不可以重複，最長為 64 個字元；標籤值可以為空白，最長為 128 個字元。標籤鍵和標籤值都不能以`aliyun`、`acs:`、`https://`或`http://`開頭。更多資訊，請參見Labels and Selectors。說明指定`nodepool_id`後，該參數不支援。
	tag	否	節點標籤。

返回參數

名稱	類型	描述	樣本值
	object	返回體參數。
list	array<object>	節點添加資訊列表。
	object	節點添加結果詳情。
code	string	節點添加結果狀態代碼。	200
instanceId	string	ECS 執行個體 ID。	i-2ze0lgm3y6iylcbt****
message	string	節點添加結果描述資訊。	successful
task_id	string	任務 ID。	T-5a544aff80282e39ea00****

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。