AttachInstances - 為伸縮組手動添加執行個體

更新時間:
Copy as MD

調用API AttachInstances將執行個體手動添加到伸縮組中,即您可以將伸縮組以外的ECS執行個體、ECI執行個體或受管理的執行個體添加到伸縮組中並提供服務,或者將伸縮組中處於節省停機狀態的ECS執行個體重新啟動變為服務狀態(運行中狀態)並在伸縮組中提供服務。

介面說明

  • 調用該介面前,請確保滿足以下條件:
    • 伸縮組處於 Active 狀態。

    • 伸縮組內沒有執行中的伸縮活動。

  • 加入伸縮組的 ECS 執行個體或 ECI 執行個體的限制條件包括:
    • 必須與伸縮組在同一個地區。

    • 必須處於 Running 狀態。

    • 不能已加入到其他伸縮組中。

    • 付費方式為訂用帳戶、隨用隨付或搶佔式執行個體。

    • 如果伸縮組指定 VswitchID,則不支援 Classic 類型的 ECS 執行個體或 ECI 執行個體加入伸縮組,也不支援其他 VPC 的 ECS 執行個體或 ECI 執行個體加入伸縮組。

    • 如果伸縮組沒有指定 VswitchID,則不支援 VPC 類型的 ECS 執行個體或 ECI 執行個體加入伸縮組。

  • 加入伸縮組的受管理的執行個體的限制條件包括:
    • 必須與伸縮組在同一個地區。

    • 只能將未加入伸縮組的受管理的執行個體加入到 ECS 類型伸縮組中。

    • 受管理的執行個體不支援配置生命週期掛鈎、關聯到負載平衡和健全狀態檢查功能。

    • 受管理的執行個體加入 ECS 類型伸縮組後,該伸縮組不會管理受管理的執行個體的生命週期。

    • 受管理的執行個體僅支援手動添加到伸縮組或手動從伸縮組移出,移出後受管理的執行個體並不會被釋放。

  • 使用該介面需注意以下事項:
    • 當伸縮組沒有伸縮活動正在執行時,該介面可以繞過冷卻時間(Cooldown)直接執行。

    • 調用該介面返回成功,只是表示Auto Scaling服務接受了該介面調用的請求,伸縮活動可以執行,但不代表伸縮活動能夠執行成功。您需要通過返回的 ScalingActivityId 查看該伸縮活動的執行狀態。

    • 如果該介面指定的執行個體數加上當前伸縮組的執行個體數(Total Capacity)大於最大值(MaxSize),則介面調用失敗。

    • 通過該介面手動添加的 ECS 執行個體、ECI 執行個體或受管理的執行個體不與伸縮組生效的伸縮配置進行關聯。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:AttachInstances

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

請求參數

名稱

類型

必填

描述

樣本值

ScalingGroupId

string

伸縮組的 ID。

asg-bp18p2yfxow2dloq****

Entrusted

boolean

將已經存在的執行個體手動添加到伸縮組時,是否將該執行個體的生命週期託管給伸縮組。取值範圍:

  • true:託管。該執行個體的生命週期由Auto Scaling管理,與伸縮組自動建立的執行個體一致。執行個體被移出伸縮組(不包括通過調用 DetachInstances 參數移出的執行個體)時會自動釋放。

  • false:不託管。該執行個體在被移出伸縮組時不會被釋放。

說明

訂用帳戶執行個體、受管理的執行個體和伸縮組中節省停機執行個體不支援設定該參數項。

預設值:false。

false

InstanceIds

array

待添加 ECS 執行個體、ECI 執行個體、受管理的執行個體或者伸縮組中處於節省停機狀態執行個體的 ID。

string

待添加 ECS 執行個體、ECI 執行個體、受管理的執行個體或者伸縮組中處於節省停機狀態執行個體的 ID。

舉例如下所示:

  • 待添加的 ECS 執行個體 ID 為 i-28wt4****。

  • 待添加的 ECI 執行個體 ID 為 eci-bp17gw49eu09yiwm****。

  • 待添加的受管理的執行個體 ID 為 mi-2cx*****。

  • 待重新啟動的伸縮組中節省停機狀態執行個體 ID 為 i-2cd2f****

說明

一次調用請求中僅支援處理一種類型的執行個體。

i-28wt4****

LoadBalancerWeights

array

ECS 執行個體或 ECI 執行個體作為Server Load Balancer執行個體後端伺服器時的權重。

integer

為 ECS 執行個體或 ECI 執行個體作為Server Load Balancer執行個體後端伺服器時的權重,該參數的取值範圍:1~100。

說明

受管理的執行個體和伸縮組中節省停機執行個體不支援設定該參數項。

預設值:50。

50

LifecycleHook

boolean

伸縮組添加執行個體時,是否觸發擴容生命週期掛鈎。取值範圍:

  • true:觸發。

  • false:不觸發。

說明

受管理的執行個體和伸縮組中節省停機執行個體不支援設定該參數項。

預設值:false。

false

RegionId

string

伸縮組所屬的地區 ID。

cn-qingdao

ClientToken

string

保證請求等冪性。

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。只支援 ASCII 字元,且不能超過 64 個字元。更多資訊,請參見如何保證等冪性

123e4567-e89b-12d3-a456-42665544****

IgnoreInvalidInstance

boolean

向伸縮組添加一批執行個體時,是否忽略其中無效的執行個體。取值範圍:

  • true:從伸縮組中添加一批執行個體時,會忽略其中無效的執行個體。如果存在無效的執行個體,並且有效執行個體被成功添加時,伸縮活動執行狀態也會顯示為警告狀態,可以從伸縮活動詳情查看無效的執行個體。

  • false:從伸縮組中添加一批執行個體時,不會忽略無效的執行個體。如果一批執行個體中存在無效的執行個體,請求會報錯。

預設值:false。

false

返回參數

名稱

類型

描述

樣本值

object

ScalingActivityId

string

伸縮活動的 ID。

asa-bp1crxor24s28xf1****

RequestId

string

請求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE****

樣本

正常返回樣本

JSON格式

{
  "ScalingActivityId": "asa-bp1crxor24s28xf1****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

500 InternalError The request processing has failed due to some unknown error, exception or failure.

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

變更歷史

更多資訊,參考變更詳情