すべてのプロダクト
Search
ドキュメントセンター

Auto Scaling:DescribeScalingGroups

最終更新日:Nov 02, 2026

スケーリンググループの基本情報、スケーリンググループ内のインスタンス、スケーリング設定などの詳細を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ess:DescribeScalingGroups

get

*ScalingGroup

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

スケーリンググループが属するリージョンの ID。

cn-qingdao

PageNumber

integer

任意

スケーリンググループリストのページ番号。ページは 1 から始まります。

デフォルト値: 1。

1

PageSize

integer

任意

ページング設定項目では、ページングクエリで各ページに返すエントリ数を指定します。最大値: 50。

デフォルト値: 10。

列挙値:

  • 10 :

    10

10

ScalingGroupName

string

任意

スケーリンググループ名。

scalinggroup****

ScalingGroupName.1

string

任意

ScalingGroupName.1 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.2

string

任意

ScalingGroupName.2 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.3

string

任意

ScalingGroupName.3 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.4

string

任意

ScalingGroupName.4 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.5

string

任意

ScalingGroupName.5 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.6

string

任意

ScalingGroupName.6 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.7

string

任意

ScalingGroupName.7 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.8

string

任意

ScalingGroupName.8 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.9

string

任意

ScalingGroupName.9 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.10

string

任意

ScalingGroupName.10 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.11

string

任意

ScalingGroupName.11 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.12

string

任意

ScalingGroupName.12 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.13

string

任意

ScalingGroupName.13 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.14

string

任意

ScalingGroupName.14 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.15

string

任意

ScalingGroupName.15 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.16

string

任意

ScalingGroupName.16 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.17

string

任意

ScalingGroupName.17 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.18

string

任意

ScalingGroupName.18 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.19

string

任意

ScalingGroupName.19 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

ScalingGroupName.20

string

任意

ScalingGroupName.20 は、クエリするスケーリンググループの名前を指定します。有効でないスケーリンググループ名は無視され、エラーは返されません。

scalinggroup****

GroupType

string

任意

スケーリンググループで管理されるインスタンスのタイプ。有効な値:

  • ECS: スケーリンググループは ECS インスタンスを管理します。

  • ECI: スケーリンググループは ECI インスタンスを管理します。

ECS

ScalingGroupId

array

任意

ScalingGroupId.N は、クエリするスケーリンググループの ID を指定します。N の有効な値: 1~20。有効でないスケーリンググループ ID は無視され、エラーは返されません。

asg-bp14wlu85wrpchm0****

string

任意

ScalingGroupId.N は、クエリするスケーリンググループの ID を指定します。N の有効な値: 1~20。有効でないスケーリンググループ ID は無視され、エラーは返されません。

asg-bp14wlu85wrpchm0****

ResourceGroupId

string

任意

照会するスケーリンググループが属するリソースグループの ID。

説明

指定されたリソースグループに属するスケーリンググループがない場合、クエリ結果は空になり、エラーは返されません。

rg-123****

Tag

array<object>

任意

スケーリンググループのタグ。

object

任意

スケーリンググループのタグ。

Key

string

任意

スケーリンググループのタグキー。

Department

Value

string

任意

スケーリンググループのタグ値。

Finance

レスポンスフィールド

フィールド

型

説明

例

object

PageNumber

integer

現在のページ番号。

1

PageSize

integer

1 ページあたりのエントリ数。

10

RequestId

string

リクエスト ID。

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

ScalingGroups

object

ScalingGroup

array<object>

スケーリンググループの情報。

array<object>

スケーリンググループの情報。

ActiveCapacity

integer

スケーリンググループに追加され、正常に実行中の ECS インスタンスの数。

1

ActiveScalingConfigurationId

string

スケーリンググループ内のアクティブなスケーリング設定の ID。

asc-bp1et2qekq3ojr33****

AlbServerGroups

object

AlbServerGroup

array<object>

ALB サーバーグループに関する情報のコレクション。

object

ALB サーバーグループに関する情報のコレクション。

AlbServerGroupId

string

ALB サーバーグループの ID。

sgp-ddwb0y0g6y9bjm****

Port

integer

Auto Scaling によって ECS インスタンスが ALB サーバーグループに追加された後に、ECS インスタンスによって使用されるポート番号。

80

Weight

integer

Auto Scaling によって ECS インスタンスが ALB サーバーグループに追加された後の、バックエンドサーバーとしての ECS インスタンスの重み。

100

AllocationStrategy

string

スケーリンググループがキャパシティーを満たすために利用可能なインスタンスタイプを選択する方法を決定するキャパシティー割り当て戦略。キャパシティーディストリビューション戦略は、従量課金とスポットの両方のキャパシティーに適用されます。有効な値:

  • priority: 設定されたインスタンスタイプの順序でインスタンスを作成します。

  • lowestPrice: インスタンスタイプの vCPU あたりの価格の昇順でインスタンスを作成します。

説明

このパラメーターは、MultiAZPolicy パラメーターが COMPOSABLE にセットされている場合にのみ効果があります。

priority

AutoRebalance

boolean

スケーリンググループの自動リバランスを有効にするかどうかを指定します。このパラメーターは、ゾーンバランススケーリンググループで BalancedOnly が有効になっている場合にのみ効果があります。有効な値:

  • false: スケーリンググループの自動リバランスを有効にしません。

  • true: スケーリンググループの自動リバランスを有効にします。有効にすると、スケーリンググループはゾーン間のキャパシティーを自動的に監視し、バランスが崩れた場合にプロアクティブにスケールアウトまたはスケールインしてキャパシティーのバランスを再調整します。

false

AzBalance

boolean

スケーリンググループのキャパシティーが複数のゾーンに均等に分散されているかどうかを指定します。有効な値:

  • true: スケーリンググループのキャパシティーは複数のゾーンに均等に分散されています。

  • false: スケーリンググループのキャパシティーは複数のゾーンに均等に分散されていません。

説明

このパラメーターは、MultiAZPolicy パラメーターが COMPOSABLE にセットされている場合にのみ効果があります。

false

BalanceMode

string

ゾーンバランシングモード。このパラメーターは、ゾーンバランシングモードが有効になっている場合にのみ効果があります。有効な値:

  • BalancedBestEffort: あるゾーンでリソースの作成に失敗した場合、システムは他のゾーンにフォールバックして、リソースのベストエフォート配信を確保します。

  • BalancedOnly: あるゾーンでリソースの作成に失敗した場合、システムは他のゾーンにフォールバックしません。スケールアウトアクティビティは部分的に成功し、異なるゾーン間でのリソースの過度な不均衡を防ぎます。

BalancedBestEffort

CapacityOptions

object

キャパシティーオプション。

CompensateWithOnDemand

boolean

MultiAZPolicy パラメーターが COST_OPTIMIZED にセットされており、価格または在庫の制約により十分なスポットインスタンスを作成できない場合に、システムが自動的に従量課金インスタンスの作成を試みて必須の ECS インスタンス数を満たすことを許可するかどうかを指定します。有効な値:

  • true: 許可します。

  • false: 許可しません。

true

OnDemandBaseCapacity

integer

スケーリンググループに必須の従量課金インスタンスの最小値。スケーリンググループ内の従量課金インスタンスの数がこの値未満の場合、システムは優先的に従量課金インスタンスを作成します。有効な値: 0~1000。

0

OnDemandPercentageAboveBaseCapacity

integer

スケーリンググループが OnDemandBaseCapacity で指定された従量課金インスタンスの最小値を満たした後の、追加インスタンスにおける従量課金インスタンスの割合。有効な値: 0~100。

0

PriceComparisonMode

string

スケーリンググループのコスト最適化戦略の価格比較モード。有効な値:

  • PricePerUnit: キャパシティーの単位あたりの価格に基づいて価格を比較します。スケーリンググループ内のインスタンスのキャパシティーは、インスタンスタイプに設定された重みに等しくなります。デフォルトの重みは 1 で、1 つの ECS インスタンスが 1 単位のキャパシティーに相当することを意味します。

  • PricePerVCpu: vCPU あたりの価格に基づいて価格を比較します。 デフォルト値: PricePerUnit。

PricePerUnit

SpotAutoReplaceOnDemand

boolean

CompensateWithOnDemand が有効で、従量課金インスタンスの割合が OnDemandPercentageAboveBaseCapacity の値を超えている場合に、従量課金キャパシティーをスポットインスタンスに置き換えることを試みるかどうかを指定します。スポットの在庫または価格の制約により CompensateWithOnDemand がスポットインスタンスを従量課金インスタンスにダウングレードする一般的なシナリオでは、この機能は過剰な従量課金キャパシティーをスポットインスタンスに置き換えて、従量課金インスタンスの長期的な保持を回避しようとします。有効な値:

  • true: 許可します。

  • false: 許可しません。

false

CompensateWithOnDemand

boolean

MultiAZPolicy パラメーターが COST_OPTIMIZED にセットされており、価格または在庫の制約により十分なスポットインスタンスを作成できない場合に、システムが自動的に従量課金インスタンスの作成を試みて必須の ECS インスタンス数を満たすことを許可するかどうかを指定します。有効な値:

  • true: 許可します。

  • false: 許可しません。

true

CreationTime

string

スケーリンググループが作成された時間。

2014-08-14T10:58Z

CustomPolicyARN

string

カスタムスケールインポリシー用の Function Compute 関数の Amazon リソースネーム (ARN)。このパラメーターは、RemovalPolicies で設定された最初の削除ポリシーが CustomPolicy である場合にのみ効果があります。

acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name

DBInstanceIds

object

DBInstanceId

array

スケーリンググループに関連付けられている ApsaraDB RDS インスタンスの ID。

string

スケーリンググループに関連付けられている ApsaraDB RDS インスタンスの ID。

rm-bp15556qzebg1****

DBInstances

object

DBInstance

array<object>

スケーリンググループに関連付けられているデータベースのリスト。

array<object>

スケーリンググループに関連付けられているデータベースの構成情報。

DBInstanceId

string

データベースのインスタンス ID。

rm-m5eqju85s45mu0***

SecurityGroupIds

object

SecurityGroupId

array

スケーリンググループによってデータベースに追加されたセキュリティグループホワイトリストのリスト。

string

スケーリンググループが、関連付けられたデータベースリスト内のセキュリティグループをデータベースセキュリティグループホワイトリストから削除するかどうかを指定します。このパラメーターは、CreateScalingGroup 操作の AttachMode パラメーターが SecurityGroup にセットされている場合にのみ、関連付けられたデータベースリストに対して有効です。有効な値:

  • true: このリスト内のセキュリティグループをデータベースセキュリティグループホワイトリストから削除します。

  • false: このリスト内のセキュリティグループをデータベースセキュリティグループホワイトリストから削除しません。

sg-uf65zt66cf2a0q47***

Type

string

データベースタイプ。有効な値:

  • RDS

  • Redis

  • MongoDB

RDS

DefaultCooldown

integer

スケーリンググループのデフォルトのクールダウン時間。クールダウン時間中、スケーリンググループは他のスケーリングアクティビティを実行することはありません。このパラメーターは、Cloud Monitoring のイベントトリガータスクノードによってトリガーされるスケーリングアクティビティにのみ適用されます。

60

DesiredCapacity

integer

スケーリンググループ内の期待されるインスタンス数。スケーリンググループは、ECS インスタンスの数を期待されるインスタンス数に自動的に維持します。

5

EnableDesiredCapacity

boolean

期待されるインスタンス数の機能を有効にするかどうかを指定します。有効な値:

  • true: 有効。スケーリンググループをクエリした後、期待されるインスタンス数が返されます。

  • false: 無効。スケーリンググループをクエリした後、期待されるインスタンス数は返されません。

false

GroupDeletionProtection

boolean

スケーリンググループの削除保護が有効かどうかを指定します。有効な値:

  • true: スケーリンググループの削除保護が有効です。この場合、スケーリンググループは削除できません。

  • false: スケーリンググループの削除保護が無効です。

true

GroupType

string

スケーリンググループによって管理されるインスタンスのタイプ。

ECS

HealthCheckType

string

スケーリンググループのヘルスチェックモード。有効な値:

  • NONE: ヘルスチェックを実行しません。

  • ECS: スケーリンググループ内のインスタンスに対してヘルスチェックを実行します。この値は、ECS スケーリンググループと ECI スケーリンググループの両方に対してインスタンスヘルスチェックを有効にするために使用されます。

  • LOAD_BALANCER: 負荷分散のヘルスチェック結果に基づいてインスタンスのヘルスステータスを決定します (CLB 負荷分散タイプは現在サポートされていません)。

ECS

HealthCheckTypes

object

HealthCheckType

array

スケーリンググループのヘルスチェックモード。有効な値:

  • NONE: ヘルスチェックを実行しません。

  • ECS: スケーリンググループ内のインスタンスに対してヘルスチェックを実行します。この値は、ECS スケーリンググループと ECI スケーリンググループの両方に対してインスタンスヘルスチェックを有効にするために使用されます。

  • LOAD_BALANCER: 負荷分散のヘルスチェック結果に基づいてインスタンスのヘルスステータスを決定します (CLB 負荷分散タイプは現在サポートされていません)。

string

スケーリンググループのヘルスチェックモード。有効な値:

  • NONE: ヘルスチェックを実行しません。

  • ECS: スケーリンググループ内のインスタンスに対してヘルスチェックを実行します。この値は、ECS スケーリンググループと ECI スケーリンググループの両方に対してインスタンスヘルスチェックを有効にするために使用されます。

  • LOAD_BALANCER: 負荷分散のヘルスチェック結果に基づいてインスタンスのヘルスステータスを決定します (CLB 負荷分散タイプは現在サポートされていません)。

ECS

InitCapacity

integer

スケーリンググループ内でスケールアウトする前の初期化状態にあるインスタンスの数。

0

LaunchTemplateId

string

スケーリンググループによって使用される起動テンプレートの ID。

lt-m5e3ofjr1zn1aw7****

LaunchTemplateOverrides

object

LaunchTemplateOverride

array<object>

起動テンプレートを拡張するインスタンスタイプ情報。

object

起動テンプレートを拡張するインスタンスタイプ情報。

InstanceType

string

起動テンプレート内のインスタンスタイプをオーバーライドする、指定されたインスタンスタイプ。

ecs.c5.xlarge

SpotPriceLimit

number

起動テンプレートをオーバーライドするインスタンスタイプ (つまり、LaunchTemplateOverride.N.InstanceType) の 1 時間あたりの最大価格。このパラメーターに N 個の値を指定して、N 個のインスタンスタイプで起動テンプレートを拡張できます。N の有効な値: 1~10。

説明

このパラメーターは、LaunchTemplateId パラメーターが指定されている場合にのみ効果があります。

0.025

WeightedCapacity

integer

指定されたインスタンスタイプの重み。これは、このインスタンスタイプの単一インスタンスがスケーリンググループで提供するキャパシティーを示します。重みが大きいほど、期待されるキャパシティーを満たすために必須のこのインスタンスタイプのインスタンス数が少なくなります。

4

LaunchTemplateVersion

string

スケーリンググループによって使用される起動テンプレートのバージョン。

Default

LifecycleState

string

スケーリンググループのライフサイクル状態。有効な値:

  • Active: スケーリンググループはアクティブです。アクティブなスケーリンググループのみが、スケーリングルールを実行してスケーリングアクティビティをトリガーするリクエストを受け入れることができます。

  • Inactive: スケーリンググループは非アクティブです。非アクティブなスケーリンググループは、スケーリングルールを実行するリクエストを受け取りません。

  • Deleting: スケーリンググループは削除中です。削除状態のスケーリンググループは、スケーリングルールを実行するリクエストを受け取らず、そのパラメーターは変更できません。

Active

LoadBalancerConfigs

object

LoadBalancerConfig

array<object>

負荷分散 CLB (旧 SLB) 構成のリスト。

object

負荷分散 CLB (旧 SLB) 構成のリスト。

LoadBalancerId

string

負荷分散 CLB (旧 SLB) のインスタンス ID。

147b46d767c-cn-qingdao-cm5****

Weight

integer

Auto Scaling によって ECS インスタンスが負荷分散 CLB サーバーグループに追加された後の、バックエンドサーバーとしての ECS インスタンスの重み。重みが大きいほど、より多くのアクセスリクエストが ECS インスタンスに割り当てられます。重みが 0 の場合、ECS インスタンスはアクセスリクエストを受け取りません。 有効な値: 0~100。

10

LoadBalancerIds

object

LoadBalancerId

array

スケーリンググループに関連付けられている負荷分散インスタンスのインスタンス ID のリスト。

string

スケーリンググループに関連付けられている負荷分散インスタンスのインスタンス ID のリスト。

lb-bp19byhscefk3x0li****

MaxInstanceLifetime

integer

スケーリンググループ内のインスタンスの最大ライフタイム。単位: 秒。 有効な値: 0 または [86400, Integer.maxValue]。値が 0 の場合、セットされた MaxInstanceLifetime 値がクリアされることを示します (つまり、MaxInstanceLifetime がセットされていません)。 デフォルト値: null。

説明

このパラメーターは、ECI スケーリンググループ、または停止済みインスタンスの非課金機能が有効になっているスケーリンググループではサポートされていません。

null

MaxSize

integer

スケーリンググループ内の ECS インスタンスの最大数。

2

MinSize

integer

スケーリンググループ内の ECS インスタンスの最小数。

1

ModificationTime

string

スケーリンググループが最後に変更された時間。

2014-08-14T10:58Z

MonitorGroupId

string

スケーリンググループに関連付けられている CloudMonitor アプリケーショングループの ID。

1497****

MultiAZPolicy

string

マルチゾーン スケーリンググループ内の ECS インスタンスのスケールアウトおよびスケールインポリシー。有効な値:

  • PRIORITY: 定義した vSwitch (VSwitchIds.N) に基づいてインスタンスをスケーリングします。最も優先度の高い vSwitch のゾーンで ECS インスタンスを作成できない場合、システムは次に優先度の高い vSwitch を自動的に使用して ECS インスタンスを作成します。

  • COST_OPTIMIZED: vCPU あたりの価格の昇順でインスタンスの作成を試みます。スケーリング設定でスポット課金方法を使用する複数のインスタンスタイプが指定されている場合、システムは優先的に対応するスポットインスタンスを作成します。CompensateWithOnDemand パラメーターを使用して、在庫またはその他の理由でスポットインスタンスを作成できない場合に、従量課金インスタンスの作成を自動的に試みるかどうかを指定できます。

    説明

    COST_OPTIMIZED は、スケーリング設定で複数のインスタンスタイプが指定されているか、スポットインスタンスが使用されている場合にのみ効果があります。

  • BALANCE: スケーリンググループに指定された複数のゾーンに ECS インスタンスを均等に割り当てます。在庫不足またはその他の理由によりゾーン間でインスタンスのバランスが崩れた場合、 RebalanceInstance 操作を呼び出してリソースのバランスを再調整できます。

  • COMPOSABLE: 要件に基づいて、マルチゾーン スケーリンググループ内の ECS インスタンスに対する前述のスケールアウトおよびスケールインポリシーを組み合わせることができるコンポーザブルポリシー。

PRIORITY

OnDemandBaseCapacity

integer

スケーリンググループに必須の従量課金インスタンスの最小値。有効な値: 0~1000。スケーリンググループ内の従量課金インスタンスの数がこの最小値未満の場合、システムは優先的に従量課金インスタンスを作成します。 デフォルト値: MultiAZPolicy パラメーターが COMPOSABLE にセットされている場合は 0。

30

OnDemandPercentageAboveBaseCapacity

integer

スケーリンググループが OnDemandBaseCapacity で指定された従量課金インスタンスの最小値を満たした後の、追加インスタンスにおける従量課金インスタンスの割合。有効な値: 0~100。 デフォルト値: MultiAZPolicy パラメーターが COMPOSABLE にセットされている場合は 100。

20

PendingCapacity

integer

スケーリンググループに追加中であるが、関連する構成が完了していない ECS インスタンスの数。

0

PendingWaitCapacity

integer

スケーリンググループ内の保留待ち状態にある ECS インスタンスの数。

1

ProtectedCapacity

integer

スケーリンググループ内の保護状態にある ECS インスタンスの数。

1

RegionId

string

スケーリンググループが属するリージョンの ID。

cn-qingdao

RemovalPolicies

object

RemovalPolicy

array

スケーリンググループから ECS インスタンスを削除するためのポリシーのコレクション。有効な値:

  • OldestInstance: 最も早く作成された ECS インスタンスを削除します。

  • NewestInstance: 最も最近作成された ECS インスタンスを削除します。

  • OldestScalingConfiguration: スケーリング設定によって最も早く作成された ECS インスタンスを削除します。

  • CustomPolicy: カスタムスケールインポリシー用の Function Compute 関数に基づいて ECS インスタンスを削除します。

string

スケーリンググループから ECS インスタンスを削除するためのポリシーのコレクション。有効な値:

  • OldestInstance: 最も早く作成された ECS インスタンスを削除します。

  • NewestInstance: 最も最近作成された ECS インスタンスを削除します。

  • OldestScalingConfiguration: スケーリング設定によって最も早く作成された ECS インスタンスを削除します。

  • CustomPolicy: カスタムスケールインポリシー用の Function Compute 関数に基づいて ECS インスタンスを削除します。

OldestScalingConfiguration

RemovingCapacity

integer

スケーリンググループから削除中の ECS インスタンスの数。

0

RemovingWaitCapacity

integer

スケーリンググループ内の削除待ち状態にある ECS インスタンスの数。

1

ResourceGroupId

string

スケーリンググループが属するリソースグループの ID。

rg-123****

ScalingGroupId

string

スケーリンググループの ID。

asg-bp14wlu85wrpchm0****

ScalingGroupName

string

スケーリンググループ名。

dyrSuvBOtO1dEdIlIbp****

ScalingPolicy

string

スケーリンググループの回収モード。有効な値:

  • recycle: スケーリンググループの回収モードはシャットダウンして回収です。

  • release: スケーリンググループの回収モードはリリースです。

  • forcerelease: スケーリンググループの回収モードは強制リリースです。 削除されたインスタンスに対するアクションの詳細については、 RemoveInstances を参照してください。

recycle

ServerGroups

object

ServerGroup

array<object>

負荷分散サーバーグループに関する情報のコレクション。

説明

このパラメーターを使用して、スケーリンググループに関連付けられている ALB サービスグループ、NLB サーバーグループ、および GWLB サービスグループに関する情報のコレクションを取得できます。

object

負荷分散サーバーグループに関する情報のコレクション。

Port

integer

Auto Scaling によってインスタンスがサーバーグループに追加された後に ECS インスタンスが使用するポート番号。

80

ServerGroupId

string

サーバーグループの ID。

sgp-i9ouakeaerr*****

Type

string

サーバーグループのタイプ。有効な値:

  • ALB: アプリケーション負荷分散 (Application Load Balancer)。

  • NLB: ネットワークロードバランサー (NLB)。

  • GWLB: ゲートウェイロードバランサー (GWLB)。

ALB

Weight

integer

Auto Scaling によってインスタンスがサーバーグループに追加された後の、バックエンドサーバーとしての ECS インスタンスの重み。

100

SpotAllocationStrategy

string

スポットキャパシティのディストリビューションポリシー。このパラメーターを使用して、スポットキャパシティのディストリビューションポリシーを指定できます。このパラメーターは、MultiAZPolicy パラメーターが COMPOSABLE にセットされている場合にのみ効果を発揮します。有効な値:

  • priority: 設定されたインスタンスタイプの優先度でインスタンスを作成します。

  • lowestPrice: インスタンスタイプの vCPU あたりの単位価格が低い順にインスタンスを作成します。

lowestPrice

SpotCapacity

integer

スケーリンググループ内のスポットインスタンスの数。

0

SpotInstancePools

integer

利用可能なインスタンスタイプの数。スケーリンググループは、コストが最も低い、指定された数のインスタンスタイプにわたってスポットインスタンスを均等に作成します。有効な値: 0~10。

デフォルト値: MultiAZPolicy パラメーターが COMPOSABLE に設定されている場合は 2。

5

SpotInstanceRemedy

boolean

スポットインスタンス補充特徴を有効にするかどうかを示します。この特徴を有効にすると、スケーリンググループは、回収に関するシステムメッセージを受信したときに、回収されようとしているスポットインスタンスを置き換えるために新しいインスタンスの作成を試みます。

true

StandbyCapacity

integer

スケーリンググループ内のスタンバイ状態のインスタンスの数。

1

StopInstanceTimeout

integer

スケールインプロセス中に ECS インスタンスが停止するのを待機するタイムアウト期間。単位: 秒。

60

StoppedCapacity

integer

スケーリンググループ内の節約モードのインスタンスの数。

1

SuspendedProcesses

object

SuspendedProcess

array

一時停止されたプロセス。プロセスが一時停止されていない場合は、空の値が返されます。有効な値:

  • ScaleIn: スケールインプロセス。

  • ScaleOut: スケールアウトプロセス。

  • HealthCheck: ヘルスチェック。

  • AlarmNotification: イベントトリガー型タスク。

  • ScheduledAction: 定期タスク。

string

一時停止されたプロセス。プロセスが一時停止されていない場合は、空の値が返されます。有効な値:

  • ScaleIn: スケールインプロセス。

  • ScaleOut: スケールアウトプロセス。

  • HealthCheck: ヘルスチェック。

  • AlarmNotification: イベントトリガー型タスク。

  • ScheduledAction: 定期タスク。

ScaleIn

SystemSuspended

boolean

Auto Scaling がスケーリンググループでのスケーリングアクティビティを実行することを停止するかどうかを示します。有効な値:

  • true: Auto Scaling はスケーリンググループでのスケーリングアクティビティを実行することを停止します。これは、スケーリンググループが 7 日以上連続してスケールアウトまたはスケールインアクティビティを実行することに失敗したことを示します。スケーリングアクティビティを実行することを回復するには、スケーリンググループまたはスケーリング設定を変更する必要があります。

  • false: Auto Scaling はスケーリンググループでスケーリングアクティビティを実行します。

true

Tags

object

Tag

array<object>

スケーリンググループのタグ。

object

スケーリンググループのタグ。

Propagate

boolean

タグが伝播されるかどうかを示します。有効な値:

  • true: スケーリンググループのタグは、新しく作成されたインスタンスにのみ伝播され、スケーリンググループ内の既存のインスタンスには伝播されません。

  • false: スケーリンググループのタグはインスタンスに伝播されません。

デフォルト値: false。

false

TagKey

string

スケーリンググループのタグキー。

Department

TagValue

string

スケーリンググループのタグ値。

Finance

TotalCapacity

integer

インスタンスタイプの重みが設定されている場合、スケーリンググループ内のすべての ECS インスタンスの合計重み付きキャパシティ。それ以外の場合、このパラメーターはスケーリンググループ内の ECS インスタンスの総数を示します。

1

TotalInstanceCount

integer

スケーリンググループ内の ECS インスタンスの総数。

1

VServerGroups

object

VServerGroup

array<object>

バックエンドサーバーグループのリスト。

array<object>

バックエンドサーバーグループのリスト。

LoadBalancerId

string

バックエンドサーバーグループが属するロードバランサーインスタンスの ID。

147b46d767c-cn-qingdao-cm5****

VServerGroupAttributes

object

VServerGroupAttribute

array<object>

バックエンドサーバーグループの属性。

object

バックエンドサーバーグループの属性。

Port

integer

ロードバランサーインスタンスが外部サービスを提供するために使用するポート番号。

22

VServerGroupId

string

バックエンドサーバーグループの ID。

rsp-bp12bjrny****

Weight

integer

バックエンドサーバーグループの重み。

1

VSwitchId

string

スケーリンググループに関連付けられている vSwitch の ID。

vsw-bp1whw2u46cn8zubm****

VSwitchIds

object

VSwitchId

array

スケーリンググループに関連付けられている vSwitch の ID。VSwitchIds パラメーターを指定すると、VSwitchId パラメーターは無視されます。

string

スケーリンググループに関連付けられている vSwitch の ID。VSwitchIds パラメーターを指定すると、VSwitchId パラメーターは無視されます。

vsw-bp1whw2u46cn8zubm****

VpcId

string

スケーリンググループが属する仮想非公開クラウド (VPC) の ID。

vpc-bp1vwnn14rqpyiczj****

WarmPoolCapacity

integer

ウォームプール内のインスタンスの数。

5

WarmPoolConfiguration

object

スケーリンググループのウォームプール構成。

CapacityOptions

object

ウォームプールのキャパシティ構成。

DesiredGroupPreparedCapacity

integer

ウォームアップ済みインスタンスの予期される数。スケーリンググループ内のインスタンス数とウォームプール内のインスタンス数の合計は、常にウォームプールの予期されるキャパシティと等しくなります。

5

MinCapacity

integer

ウォームプール内に維持するインスタンスの最小値。

0

InstanceReusePolicy

object

インスタンス回収ポリシー。

ReuseOnScaleIn

boolean

スケールインプロセス中にインスタンスがウォームプールに再度追加されるかどうかを示します。

PoolState

string

ウォームプール内のインスタンスステータス。有効な値:

  • Stopped: 節約モード。

  • Running: 実行中。

Running

Status

string

ウォームプールのステータス。有効な値:

  • Active: アクティブな。

  • Deleting: 削除中。

Active

TotalCount

integer

スケーリンググループの総数。

1

例

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScalingGroups": {
    "ScalingGroup": [
      {
        "ActiveCapacity": 1,
        "ActiveScalingConfigurationId": "asc-bp1et2qekq3ojr33****",
        "AlbServerGroups": {
          "AlbServerGroup": [
            {
              "AlbServerGroupId": "sgp-ddwb0y0g6y9bjm****",
              "Port": 80,
              "Weight": 100
            }
          ]
        },
        "AllocationStrategy": "優先度",
        "AutoRebalance": false,
        "AzBalance": false,
        "BalanceMode": "BalancedBestEffort",
        "CapacityOptions": {
          "CompensateWithOnDemand": true,
          "OnDemandBaseCapacity": 0,
          "OnDemandPercentageAboveBaseCapacity": 0,
          "PriceComparisonMode": "PricePerUnit",
          "SpotAutoReplaceOnDemand": false
        },
        "CompensateWithOnDemand": true,
        "CreationTime": "2014-08-14T10:58Z",
        "CustomPolicyARN": "acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_ポリシー.LATEST/関数/ess_custom_terminate_ポリシー_name",
        "DBInstanceIds": {
          "DBInstanceId": [
            "rm-bp15556qzebg1****"
          ]
        },
        "DBInstances": {
          "DBInstance": [
            {
              "DBInstanceId": "rm-m5eqju85s45mu0***",
              "SecurityGroupIds": {
                "SecurityGroupId": [
                  "sg-uf65zt66cf2a0q47***"
                ]
              },
              "Type": "RDS"
            }
          ]
        },
        "DefaultCooldown": 60,
        "DesiredCapacity": 5,
        "EnableDesiredCapacity": false,
        "GroupDeletionProtection": true,
        "GroupType": "ECS",
        "HealthCheckType": "ECS",
        "HealthCheckTypes": {
          "HealthCheckType": [
            "ECS"
          ]
        },
        "InitCapacity": 0,
        "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
        "LaunchTemplateOverrides": {
          "LaunchTemplateOverride": [
            {
              "InstanceType": "ecs.c5.xlarge",
              "SpotPriceLimit": 0.025,
              "WeightedCapacity": 4
            }
          ]
        },
        "LaunchTemplateVersion": "Default",
        "LifecycleState": "Active",
        "LoadBalancerConfigs": {
          "LoadBalancerConfig": [
            {
              "LoadBalancerId": "147b46d767c-cn-qingdao-cm5****",
              "Weight": 10
            }
          ]
        },
        "LoadBalancerIds": {
          "LoadBalancerId": [
            "lb-bp19byhscefk3x0li****"
          ]
        },
        "MaxInstanceLifetime": 0,
        "MaxSize": 2,
        "MinSize": 1,
        "ModificationTime": "2014-08-14T10:58Z",
        "MonitorGroupId": "1497****",
        "MultiAZPolicy": "PRIORITY",
        "OnDemandBaseCapacity": 30,
        "OnDemandPercentageAboveBaseCapacity": 20,
        "PendingCapacity": 0,
        "PendingWaitCapacity": 1,
        "ProtectedCapacity": 1,
        "RegionId": "cn-qingdao",
        "RemovalPolicies": {
          "RemovalPolicy": [
            "OldestScalingConfiguration"
          ]
        },
        "RemovingCapacity": 0,
        "RemovingWaitCapacity": 1,
        "ResourceGroupId": "rg-123****",
        "ScalingGroupId": "asg-bp14wlu85wrpchm0****",
        "ScalingGroupName": "dyrSuvBOtO1dEdIlIbp****",
        "ScalingPolicy": "recycle",
        "ServerGroups": {
          "ServerGroup": [
            {
              "Port": 80,
              "ServerGroupId": "sgp-i9ouakeaerr*****",
              "Type": "ALB",
              "Weight": 100
            }
          ]
        },
        "SpotAllocationStrategy": "lowestPrice",
        "SpotCapacity": 0,
        "SpotInstancePools": 5,
        "SpotInstanceRemedy": true,
        "StandbyCapacity": 1,
        "StopInstanceTimeout": 60,
        "StoppedCapacity": 1,
        "SuspendedProcesses": {
          "SuspendedProcess": [
            "ScaleIn"
          ]
        },
        "SystemSuspended": true,
        "Tags": {
          "Tag": [
            {
              "Propagate": false,
              "TagKey": "部門",
              "TagValue": "財務"
            }
          ]
        },
        "TotalCapacity": 1,
        "TotalInstanceCount": 1,
        "VServerGroups": {
          "VServerGroup": [
            {
              "LoadBalancerId": "147b46d767c-cn-qingdao-cm5****",
              "VServerGroupAttributes": {
                "VServerGroupAttribute": [
                  {
                    "Port": 22,
                    "VServerGroupId": "rsp-bp12bjrny****",
                    "Weight": 1
                  }
                ]
              }
            }
          ]
        },
        "VSwitchId": "vsw-bp1whw2u46cn8zubm****",
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1whw2u46cn8zubm****"
          ]
        },
        "VpcId": "vpc-bp1vwnn14rqpyiczj****",
        "WarmPoolCapacity": 5,
        "WarmPoolConfiguration": {
          "CapacityOptions": {
            "DesiredGroupPreparedCapacity": 5,
            "MinCapacity": 0
          },
          "InstanceReusePolicy": {
            "ReuseOnScaleIn": false
          },
          "PoolState": "Running",
          "Status": "Active"
        }
      }
    ]
  },
  "TotalCount": 1
}

エラーコード

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

変更履歴

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