調用DATASOURCE::ESS::ScalingGroups查詢伸縮組 -

DATASOURCE::ESS::ScalingGroups類型用於查詢伸縮組。

文法

{
  "Type": "DATASOURCE::ESS::ScalingGroups",
  "Properties": {
    "ScalingGroupNames": List,
    "GroupType": String,
    "ScalingGroupIds": List,
    "RefreshOptions": String
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
ScalingGroupNames	List	否	是	伸縮組名稱列表。	查詢結果會忽略失效的伸縮組名稱，並且不報錯。說明一次最多可查詢20個伸縮組名稱。
GroupType	String	否	是	伸縮組管理執行個體類型。	取值： ECS：ECS執行個體（預設值）。 ECI：ECI執行個體。
ScalingGroupIds	List	否	是	待查詢伸縮組ID列表。	查詢結果會忽略失效的伸縮組ID，並且不報錯。說明一次最多可以查詢20個伸縮組ID。
RefreshOptions	String	否	是	當資源棧更新時，資料來源資源的重新整理策略。	有效值： Never（預設值）：更新堆棧時，從不重新整理資料來源資源。 Always：更新堆棧時，始終重新整理資料來源資源。

返回資料（Fn::GetAtt）

ScalingGroups：伸縮組詳情列表。
ScalingGroupIds：伸縮組ID列表。

屬性名稱	類型	描述	約束
ScalingGroupIds	List	伸縮組ID列表。	無
ScalingGroups	List	伸縮組詳情列表。	無
DesiredCapacity	Number	伸縮組內ECS執行個體期望數量。	伸縮組會自動將ECS執行個體數量維持在期望執行個體數。
LifecycleState	String	伸縮組狀態資訊。	取值： Active：生效狀態。處於生效狀態的伸縮組才能接收執行伸縮規則的請求並觸發伸縮活動。 Inactive：失效狀態。
TotalInstanceCount	Number	伸縮組內所有ECS執行個體數量。	無
Weighted	Boolean	是否設定了執行個體規格的權重。	取值： true：已設定執行個體規格的權重。 false：未設定執行個體規格的權重。
RemovalPolicies	List	ECS執行個體移出伸縮組的策略集合。	取值： OldestInstance：移出最早建立的ECS執行個體。 NewestInstance：移出最新建立的ECS執行個體。 OldestScalingConfiguration：移出最早由伸縮配置建立的ECS執行個體。
PendingWaitCapacity	Number	伸縮組中處於加入掛起狀態的ECS執行個體數量。	無
TotalCapacity	Number	當伸縮組設定了執行個體規格權重，表示伸縮組內所有ECS執行個體的加權容量總和。否則，表示伸縮組內所有ECS執行個體的數量。	無
RemovingWaitCapacity	Number	伸縮組中處於移除掛起狀態的ECS執行個體數量。	無
IsElasticStrengthInAlarm	Boolean	是否觸發Auto Scaling警示。	無
ProtectedCapacity	Number	伸縮組中處於保護狀態的ECS執行個體數量。	無
StandbyCapacity	Number	伸縮組中處於備用狀態的執行個體數量。	無
ScalingPolicy	String	指定伸縮組的回收模式。	取值： recycle：停機回收模式。 release：釋放模式。說明關於被移出執行個體的動作，請參見RemoveInstances。
SuspendedProcesses	List	暫停中的流程。	取值： ScaleIn：縮容流程。 ScaleOut：擴容流程。 HealthCheck：健全狀態檢查。 AlarmNotification：警示任務。 ScheduledAction：定時任務。
RemovingCapacity	Number	正在移出伸縮組的ECS執行個體的數量。	無
VSwitchIds	List	伸縮組關聯虛擬交換器的ID集合。	如果您使用了本參數，VSwitchId參數將被忽略。
ScalingGroupId	String	伸縮組ID。	無
PendingCapacity	Number	正在加入伸縮組。	還未完成相關配置的ECS執行個體數量。
VSwitchId	String	伸縮組關聯虛擬交換器ID。	無
LoadBalancerIds	List	伸縮組關聯的Server Load Balancer執行個體ID列表。	無
GroupDeletionProtection	Boolean	是否開啟了伸縮組刪除保護。	取值： true：開啟伸縮組刪除保護。此時不能刪除該伸縮組。 false：關閉伸縮組刪除保護。
MaxSize	Number	伸縮組內ECS執行個體台數的最大值。	無
ScalingGroupName	String	伸縮組名稱。	無
MinSize	Number	伸縮組內ECS執行個體台數的最小值。	無
ActiveCapacity	Number	已成功加入伸縮組。	正常啟動並執行ECS執行個體數量。
DefaultCooldown	Number	伸縮組預設的冷卻時間。	冷卻時間內，該伸縮組不執行其他的伸縮活動，僅針對CloudMonitor警示任務觸發的伸縮活動有效。
VpcId	String	伸縮組所屬VPC的ID。	無
GroupType	String	伸縮組管理的執行個體類型。	取值： ECS（預設值）：ECS執行個體。 ECI：ECI執行個體。
SystemSuspended	Boolean	Auto Scaling是否停止執行伸縮組內的伸縮活動。	取值： true：停止執行伸縮組內的伸縮活動。（伸縮組已經連續擴容或縮容失敗超過7天。）您需要修改伸縮組或者伸縮配置，恢複執行伸縮活動。 false：執行伸縮組內的伸縮活動。
CreationTime	String	伸縮組的建立時間。	無
MultiAZPolicy	String	多可用性區域伸縮組ECS執行個體擴容或縮容策略。	取值： PRIORITY：根據您定義的虛擬交換器（VSwitchIds）擴容或縮容。當優先順序較高的虛擬交換器所在可用性區域無法建立ECS執行個體時，自動使用下一優先順序的虛擬交換器建立ECS執行個體。 COST_OPTIMIZED：按vCPU單價從低到高進行嘗試建立。當伸縮配置設定了搶佔式計費方式的多執行個體規格時，優先建立對應搶佔式執行個體。由於庫存等原因無法建立搶佔式執行個體時，您可以通過CompensateWithOnDemand參數指定是否自動嘗試以隨用隨付的方式建立。說明 COST_OPTIMIZED僅在伸縮配置設定了多執行個體規格或者選用了搶佔式執行個體的情況下生效。 BALANCE：在伸縮組指定的多可用性區域之間均勻分配ECS執行個體。如果由於庫存不足等原因可用性區域之間變得不平衡，您可以通過API RebalanceInstances平衡資源。
StoppedCapacity	Number	伸縮組中處於節省停機效果的執行個體數量。	無
DBInstanceIds	List	伸縮組關聯RDS執行個體ID。	樣本：`[ "rm-bp15556qzebg1**", "rm-shj1829939342**"]`
HealthCheckType	String	伸縮組的健全狀態檢查方式。	取值： NONE：不做健全狀態檢查。 ECS：對伸縮組內的ECS執行個體做健全狀態檢查。

樣本

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupType": {
      "Type": "String",
      "Description": "The type of instances that are managed by the scaling group. Valid values:\nECS: the Elastic Compute Service (ECS) instances\nECI: the elastic container instances\nDefault value: ECS.",
      "Default": "ECS"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ESS::ScalingGroups",
      "Properties": {
        "GroupType": {
          "Ref": "GroupType"
        }
      }
    }
  },
  "Outputs": {
    "ScalingGroups": {
      "Description": "The list of scaling groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScalingGroups"
        ]
      }
    },
    "ScalingGroupIds": {
      "Description": "The list of scaling group IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScalingGroupIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupType:
    Type: String
    Description: |-
      The type of instances that are managed by the scaling group. Valid values:
      ECS: the Elastic Compute Service (ECS) instances
      ECI: the elastic container instances
      Default value: ECS.
    Default: ECS
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ESS::ScalingGroups
    Properties:
      GroupType:
        Ref: GroupType
Outputs:
  ScalingGroups:
    Description: The list of scaling groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScalingGroups
  ScalingGroupIds:
    Description: The list of scaling group IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ScalingGroupIds