DescribeScalingInstances - Auto Scaling

呼叫DescribeScalingInstances，透過伸縮群組ID查詢該伸縮群組內的ECS執行個體清單及執行個體資訊，包括目前伸縮群組中，執行狀態的搶占式執行個體總數、ECS執行個體總數、ECS執行個體的預熱狀態、生命週期狀態等。同時也支援指定執行個體健康狀態、生命週期狀態、建立方式等篩選符合要求的ECS執行個體。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DescribeScalingInstances

get

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	伸縮群組所屬地域的 ID。	cn-hangzhou
ScalingGroupId	string	否	伸縮群組的 ID。	asg-bp1igpak5ft1flyp****
ScalingConfigurationId	string	否	關聯伸縮組態的 ID。	asc-bp1i65jd06v04vdh****
HealthStatus	string	否	ECS 執行個體或 ECI 執行個體在伸縮群組中的健康狀態。未處於執行中（Running）狀態的 ECS 執行個體或 ECI 執行個體會被判定為不健康的執行個體，取值範圍： Healthy：健康的 ECS 執行個體或 ECI 執行個體。 Unhealthy：不健康的 ECS 執行個體或 ECI 執行個體。彈性伸縮會自動移出伸縮群組中不健康的 ECS 執行個體或 ECI 執行個體，並釋放自動建立的 ECS 執行個體或 ECI 執行個體。是否釋放手動新增的 ECS 執行個體或 ECI 執行個體由其託管狀態決定。如果執行個體生命週期未託管給伸縮群組，只移出執行個體但不釋放。如果執行個體生命週期託管給伸縮群組，移出並釋放執行個體。說明請確保帳號可用額度充足。如果帳號欠費，所有後付費的 ECS 執行個體或 ECI 執行個體（包括按量付費執行個體和搶占式執行個體）都會停機，甚至被釋放。欠費後伸縮群組內 ECS 執行個體或 ECI 執行個體狀態變化，請參見欠費說明。	Healthy
LifecycleState	string	否	ECS 執行個體、ECI 執行個體或託管執行個體在伸縮群組中的生命週期狀態，取值範圍： InService：已成功加入伸縮群組並正常提供服務。 Pending：加入中。ECS 執行個體或 ECI 執行個體加入伸縮群組時包括加入負載平衡執行個體的後端伺服器、RDS 執行個體的存取白名單等過程。 Pending:Wait：加入暫止中。如果伸縮群組內建立了適用於彈性擴張活動的生命週期掛鉤，ECS 執行個體或 ECI 執行個體在加入伸縮群組時被暫止並等待掛鉤逾時時間結束。 Protected：保護中。ECS 執行個體或 ECI 執行個體正常提供服務，但彈性伸縮不管理 ECS 執行個體或 ECI 執行個體的生命週期，而是由您手動管理。 Standby：備用中。ECS 執行個體或 ECI 執行個體不提供服務，負載平衡權重被置為零，且彈性伸縮不管理 ECS 執行個體的生命週期，而是由您手動管理。 Stopped：停用中。ECS 執行個體、ECI 執行個體或託管執行個體已停機，不提供服務。 Removing：移出中。ECS 執行個體或 ECI 執行個體移出伸縮群組時包括移出負載平衡執行個體的後端伺服器、RDS 執行個體的存取白名單等過程。 Removing:Wait：移出暫止中。如果伸縮群組內建立了適用於彈性收縮活動的生命週期掛鉤，ECS 執行個體或 ECI 執行個體在移出伸縮群組時被暫止並等待掛鉤逾時時間結束。說明託管執行個體不支援設定生命週期掛鉤、關聯到負載平衡和健康檢查功能。	InService
CreationType	string	否	伸縮群組中執行個體的建立方式，取值範圍： AutoCreated：彈性伸縮根據執行個體組態資訊來源自動建立的 ECS 執行個體或 ECI 執行個體。 Attached：不是透過彈性伸縮服務建立，而是由您手動新增到伸縮群組中的 ECS 執行個體或 ECI 執行個體。 Managed：不是透過彈性伸縮服務建立，而是由您手動新增到伸縮群組中的託管執行個體。	AutoCreated
PageNumber	integer	否	執行個體清單的頁碼，起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁筆數，最大值：100。預設值：10。	10
ScalingActivityId	string	否	伸縮活動的 ID。	asa-bp1c9djwrgxjyk31****
InstanceId	array	否	伸縮群組中執行個體的 ID。	i-bp109k5j3dum1ce6****
	string	否	伸縮群組中執行個體的 ID，N 的取值範圍：1～20。返回查詢結果時忽略失效的 InstanceId，並且不回報錯誤。	i-bp109k5j3dum1ce6****
CreationTypes	array	否	伸縮群組中執行個體的建立方式，此參數和 CreationType 參數只能同時傳入一個。
	string	否	伸縮群組中執行個體的建立方式，此參數和 CreationType 參數不能同時設定。取值範圍： AutoCreated：彈性伸縮根據執行個體組態資訊來源自動建立的 ECS 執行個體。 Attached：不是透過彈性伸縮服務建立，而是由您手動新增到伸縮群組中的 ECS 執行個體。 Managed：不是透過彈性伸縮服務建立，而是由您手動新增到伸縮群組中的託管執行個體。說明設定該參數時，您可以選擇多個建立方式（例如取值為 AutoCreated、Attached、Managed）。	AutoCreated
LifecycleStates	array	否	ECS 執行個體、ECI 執行個體或託管執行個體在伸縮群組中的生命週期狀態清單，此參數和`LifecycleState`參數只能同時傳入一個，建議您使用此參數。
	string	否	ECS 執行個體、ECI 執行個體或託管執行個體在伸縮群組中的生命週期狀態，取值範圍： InService：已成功加入伸縮群組並正常提供服務。 Pending：加入中。ECS 執行個體或 ECI 執行個體加入伸縮群組時包括加入負載平衡執行個體的後端伺服器、RDS 執行個體的存取白名單等過程。 Pending:Wait：加入暫止中。如果伸縮群組內建立了適用於彈性擴張活動的生命週期掛鉤，ECS 執行個體或 ECI 執行個體在加入伸縮群組時被暫止並等待掛鉤逾時時間結束。 Protected：保護中。ECS 執行個體或 ECI 執行個體正常提供服務，但彈性伸縮不管理 ECS 執行個體或 ECI 執行個體的生命週期，而是由您手動管理。 Standby：備用中。ECS 執行個體或 ECI 執行個體不提供服務，負載平衡權重被置為零，且彈性伸縮不管理 ECS 執行個體的生命週期，而是由您手動管理。 Stopped：停用中。ECS 執行個體、ECI 執行個體或託管執行個體已停機，不提供服務。 Removing：移出中。ECS 執行個體或 ECI 執行個體移出伸縮群組時包括移出負載平衡執行個體的後端伺服器、RDS 執行個體的存取白名單等過程。 Removing:Wait：移出暫止中。如果伸縮群組內建立了適用於彈性收縮活動的生命週期掛鉤，ECS 執行個體或 ECI 執行個體在移出伸縮群組時被暫止並等待掛鉤逾時時間結束。說明託管執行個體不支援設定生命週期掛鉤、關聯到負載平衡和健康檢查功能。	InService

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	B13527BF-1FBD-4334-A512-20F5E9D3****
PageSize	integer	每頁筆數。	10
PageNumber	integer	目前頁碼。	1
TotalSpotCount	integer	目前伸縮群組中，執行狀態的搶占式執行個體總數。	4
TotalCount	integer	執行個體的總數。	1
ScalingInstances	object
ScalingInstance	array<object>	執行個體資訊組成的集合。
	object	執行個體資訊組成的集合。
CreationTime	string	執行個體加入伸縮群組的時間，採用 ISO 8601 格式的 UTC 時間，精確到分鐘。	2020-05-18T03:11Z
LoadBalancerWeight	integer	負載平衡執行個體權重。說明該參數已棄用，不建議使用。	50
LaunchTemplateId	string	執行個體啟動範本的 ID。	lt-m5e3ofjr1zn1aw7****
InstanceId	string	執行個體的 ID。	i-bp109k5j3dum1ce6****
SpotStrategy	string	搶占式執行個體的搶占策略。可能值： SpotWithPriceLimit：設定上限價格的搶占式執行個體。 SpotAsPriceGo：系統自動出價，跟隨目前市場實際價格。	SpotWithPriceLimit
LaunchTemplateVersion	string	執行個體啟動範本的版本。	1
HealthStatus	string	ECS 執行個體或 ECI 執行個體在伸縮群組中的健康狀態。未處於執行中（Running）狀態的 ECS 執行個體或 ECI 執行個體會被判定為不健康的執行個體，可能值： Healthy：健康的 ECS 執行個體或 ECI 執行個體。 Unhealthy：不健康的 ECS 執行個體或 ECI 執行個體。彈性伸縮會自動移出伸縮群組中不健康的 ECS 執行個體或 ECI 執行個體，並釋放自動建立的 ECS 執行個體或 ECI 執行個體。是否釋放手動新增的 ECS 執行個體或 ECI 執行個體由其託管狀態決定。如果執行個體生命週期未託管給伸縮群組，只移出執行個體但不釋放。如果執行個體生命週期託管給伸縮群組，移出並釋放執行個體。說明請確保帳號可用額度充足。如果帳號欠費，所有後付費的 ECS 執行個體或 ECI 執行個體（包括按量付費執行個體和搶占式執行個體）都會停機，甚至被釋放。欠費後伸縮群組內 ECS 執行個體或 ECI 執行個體狀態變化，請參見欠費說明。	Healthy
ScalingGroupId	string	所屬伸縮群組的 ID。	asg-bp1igpak5ft1flyp****
WarmupState	string	執行個體的預熱狀態，可能值： NoNeedWarmup：不需要預熱。 WaitingForInstanceWarmup：等待預熱結束。 InstanceWarmupFinish：預熱結束。	NoNeedWarmup
LifecycleState	string	ECS 執行個體、ECI 執行個體或託管執行個體在伸縮群組中的生命週期狀態，可能值： InService：已成功加入伸縮群組並正常提供服務。 Pending：加入中。ECS 執行個體或 ECI 執行個體加入伸縮群組時包括加入負載平衡執行個體的後端伺服器、RDS 執行個體的存取白名單等過程。 Pending:Wait：加入暫止中。如果伸縮群組內建立了適用於彈性擴張活動的生命週期掛鉤，ECS 執行個體或 ECI 執行個體在加入伸縮群組時被暫止並等待掛鉤逾時時間結束。 Protected：保護中。ECS 執行個體或 ECI 執行個體正常提供服務，但彈性伸縮不管理 ECS 執行個體或 ECI 執行個體的生命週期，而是由您手動管理。 Standby：備用中。ECS 執行個體或 ECI 執行個體不提供服務，負載平衡權重被置為零，且彈性伸縮不管理 ECS 執行個體的生命週期，而是由您手動管理。 Stopped：停用中。ECS 執行個體、ECI 執行個體或託管執行個體已停機，不提供服務。 Removing：移出中。ECS 執行個體或 ECI 執行個體移出伸縮群組時包括移出負載平衡執行個體的後端伺服器、RDS 執行個體的存取白名單等過程。 Removing:Wait：移出暫止中。如果伸縮群組內建立了適用於彈性收縮活動的生命週期掛鉤，ECS 執行個體或 ECI 執行個體在移出伸縮群組時被暫止並等待掛鉤逾時時間結束。說明託管執行個體不支援設定生命週期掛鉤、關聯到負載平衡和健康檢查功能。	InService
CreationType	string	伸縮群組中執行個體的建立方式，可能值： AutoCreated：彈性伸縮根據執行個體組態資訊來源自動建立的 ECS 執行個體。 Attached：不是透過彈性伸縮服務建立，而是由您手動新增到伸縮群組中的 ECS 執行個體。 Managed：不是透過彈性伸縮服務建立，而是由您手動新增到伸縮群組中的託管執行個體。	AutoCreated
ZoneId	string	執行個體所屬的可用區 ID。	cn-hangzhou-g
ScalingConfigurationId	string	關聯伸縮組態的 ID。	asc-bp1i65jd06v04vdh****
Entrusted	boolean	手動新增執行個體到伸縮群組時，是否將執行個體託管給伸縮群組，託管狀態的手動新增執行個體，在移除伸縮群組（不包括手動移除）時，將執行釋放操作。可能值： true：將執行個體託管給伸縮群組。 false：不將執行個體託管給伸縮群組。	true
WeightedCapacity	integer	執行個體規格的權重，即執行個體規格的單台執行個體在伸縮群組中表示的容量大小。權重越大，滿足期望容量所需的本執行個體規格的執行個體數量越少。	4
CreatedTime	string	執行個體加入伸縮群組的時間，採用 ISO 8601 格式的 UTC 時間，精確到秒。	2020-05-18T03:11:39Z
ScalingActivityId	string	執行個體加入伸縮群組時，伸縮活動的 ID。	asa-bp1c9djwrgxjyk31****
InstanceType	string	執行個體的規格。	ecs.n1.small
ScalingInstanceId	string	伸縮群組內的執行個體識別碼，與 ECS 執行個體或 ECI 執行個體的 ID 一一對應。	asi-j6cj1gcte640ekhb****
PrivateIpAddress	string	伸縮群組中執行個體的內部網路 IP 位址。	1*.2.1.2
ReplaceStatus	string	執行個體處於的執行個體替換流程，可能值： Normal：不處於任何替換流程； ReBalance：處於伸縮群組再均衡替換流程； SpotRemedy：處於 Spot 補償替換流程； MaxInstanceLifetimeExpire：處於執行個體最大存活時間到期替換流程； InstanceRefresh：處於執行個體重新整理替換流程； SpotReplaceOnDemand：處於 Spot 替換按量付費替換流程。	ReBalance

樣本

正常返回樣本

JSON格式

{
  "RequestId": "B13527BF-1FBD-4334-A512-20F5E9D3****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalSpotCount": 4,
  "TotalCount": 1,
  "ScalingInstances": {
    "ScalingInstance": [
      {
        "CreationTime": "2020-05-18T03:11Z",
        "LoadBalancerWeight": 50,
        "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
        "InstanceId": "i-bp109k5j3dum1ce6****",
        "SpotStrategy": "SpotWithPriceLimit",
        "LaunchTemplateVersion": "1",
        "HealthStatus": "Healthy",
        "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
        "WarmupState": "NoNeedWarmup",
        "LifecycleState": "InService",
        "CreationType": "AutoCreated",
        "ZoneId": "cn-hangzhou-g",
        "ScalingConfigurationId": "asc-bp1i65jd06v04vdh****",
        "Entrusted": true,
        "WeightedCapacity": 4,
        "CreatedTime": "2020-05-18T03:11:39Z",
        "ScalingActivityId": "asa-bp1c9djwrgxjyk31****",
        "InstanceType": "ecs.n1.small",
        "ScalingInstanceId": "asi-j6cj1gcte640ekhb****",
        "PrivateIpAddress": "1**.2*.1**.2**",
        "ReplaceStatus": "ReBalance"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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