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

Auto Scaling:DescribeScalingGroups

最終更新日:Sep 17, 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

任意

ページング時の 1 ページあたりのエントリ数。最大値: 50。

デフォルト値: 10。

列挙値:

  • 10 :

    10

10

ScalingGroupName

string

任意

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

スケーリンググループ****

ScalingGroupName.1

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.2

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.3

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.4

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.5

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.6

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.7

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.8

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.9

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.10

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.11

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.12

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.13

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.14

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.15

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.16

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.17

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.18

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.19

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

ScalingGroupName.20

string

任意

照会するスケーリンググループ N の名前。有効でないスケーリンググループ名は無視され、エラーは返されません。

スケーリンググループ****

GroupType

string

任意

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

  • ECS: ECS インスタンスがスケーリンググループで管理されます。

  • ECI: ECI インスタンスがスケーリンググループで管理されます。

ECS

ScalingGroupId

array

任意

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

asg-bp14wlu85wrpchm0****

string

任意

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

asg-bp14wlu85wrpchm0****

ResourceGroupId

string

任意

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

説明

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

rg-123****

Tag

array<object>

任意

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

object

任意

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

Key

string

任意

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

部門

Value

string

任意

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

財務

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

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

PageNumber

integer

現在のページのページ番号。

1

PageSize

integer

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

10

TotalCount

integer

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

1

ScalingGroups

object

ScalingGroup

array<object>

スケーリンググループ情報のコレクション。

array<object>

スケーリンググループ情報のコレクション。

VpcId

string

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

vpc-bp1vwnn14rqpyiczj****

CreationTime

string

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

2014-08-14T10:58Z

TotalInstanceCount

integer

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

1

ScalingGroupName

string

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

dyrSuvBOtO1dEdIlIbp****

SpotInstancePools

integer

利用可能なインスタンスタイプの数。スケーリンググループは、指定されたインスタンスタイプにわたって費用対効果の高い方法でスポットインスタンスを作成します。有効な値: 0~10。

MultiAZPolicy が COMPOSABLE にセットされている場合、デフォルト値は 2 です。

5

StoppedCapacity

integer

スケーリンググループ内で節約モード (停止済み) になっているインスタンスの数。

1

OnDemandPercentageAboveBaseCapacity

integer

従量課金インスタンスの最小値 (OnDemandBaseCapacity) が満たされた場合の超過インスタンスにおける従量課金インスタンスの割合 (タグ設定とは無関係)。有効な値: 0~100。

MultiAZPolicy が COMPOSABLE にセットされている場合、デフォルト値は 100 です。

20

ModificationTime

string

スケーリンググループが最後に変更済みとなった時間。

2014-08-14T10:58Z

MinSize

integer

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

1

ScalingGroupId

string

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

asg-bp14wlu85wrpchm0****

CompensateWithOnDemand

boolean

MultiAZPolicy が COST_OPTIMIZED にセットされている場合、コストや在庫不足などの理由でスポットインスタンスを作成できないときに、API 呼び出しなしで従量課金 ECS インスタンスを自動的に作成するかどうかを指定します。有効な値:

  • true: 従量課金 ECS インスタンスを作成します。

  • false: 従量課金 ECS インスタンスを作成しません。

true

ScalingPolicy

string

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

  • recycle: スケーリンググループはシャットダウンおよび回収モードを使用します。

  • release: スケーリンググループはリリースモードを使用します。

  • forcerelease: スケーリンググループは強制リリースモードを使用します。

削除されたインスタンスに対する操作の詳細については、 RemoveInstances を参照してください。

recycle

RemovingWaitCapacity

integer

スケーリンググループ内で削除保留状態になっている ECS インスタンスの数。

1

ActiveCapacity

integer

スケーリンググループに追加され、想定通りに実行中である ECS インスタンスの数。

1

OnDemandBaseCapacity

integer

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

MultiAZPolicy が COMPOSABLE にセットされている場合、デフォルト値は 0 です。

30

ProtectedCapacity

integer

スケーリンググループ内で保護状態になっている ECS インスタンスの数。

1

HealthCheckType

string

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

  • NONE: ヘルスチェックは実行されません。

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

  • LOAD_BALANCER: インスタンスのヘルスステータスは、ロードバランサーのヘルスチェック結果に基づいて判断されます。CLB タイプのロードバランサーはサポートされていません。

ECS

LifecycleState

string

スケーリンググループのステータス。有効な値:

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

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

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

Active

GroupDeletionProtection

boolean

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

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

  • false: 削除保護が無効です。

true

ActiveScalingConfigurationId

string

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

asc-bp1et2qekq3ojr33****

GroupType

string

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

ECS

MultiAZPolicy

string

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

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

  • COST_OPTIMIZED: vCPU の単価が安い順に ECS インスタンスが作成されます。スケーリング設定でスポット課金方法の複数のインスタンスタイプが指定されている場合、スポットインスタンスが優先的に作成されます。CompensateWithOnDemand パラメーターを使用して、在庫不足によりスポットインスタンスを作成できない場合に、従量課金インスタンスを自動的に作成するかどうかを指定できます。

    説明

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

  • BALANCE: ECS インスタンスは、スケーリンググループに指定されたゾーン全体に均等に分散されます。在庫不足などの理由でインスタンスがゾーン間で不均等に分散された場合、 RebalanceInstance 操作を呼び出してリソースをリバランスできます。

  • COMPOSABLE: ECS インスタンスの前述のマルチゾーン スケーリングポリシーの組み合わせをカスタマイズできる複合ポリシー。スケールインとスケールアウトの設定項目を個別に構成できます。アクティブなゾーン間で、異なる課金方法に基づいてインスタンスを割り当てることができます。

PRIORITY

RemovingCapacity

integer

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

0

PendingWaitCapacity

integer

スケーリンググループ内で追加保留状態になっている ECS インスタンスの数。

1

StandbyCapacity

integer

スケーリンググループ内でスタンバイ状態になっているインスタンスの数。

1

PendingCapacity

integer

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

0

LaunchTemplateId

string

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

lt-m5e3ofjr1zn1aw7****

TotalCapacity

integer

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

1

DesiredCapacity

integer

スケーリンググループ内の期待インスタンス数。スケーリンググループは、追加の API 呼び出しなしで、ECS インスタンスの数を期待インスタンス数に自動的に維持します。

5

SpotInstanceRemedy

boolean

補充スポットインスタンスが有効かどうかを示します。有効にすると、スケーリンググループは、回収通知を受信した後、回収されようとしているスポットインスタンスを置き換えるために、新しいインスタンスの作成を試みます。

true

LaunchTemplateVersion

string

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

Default

RegionId

string

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

cn-qingdao

VSwitchId

string

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

vsw-bp1whw2u46cn8zubm****

MaxSize

integer

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

2

DefaultCooldown

integer

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

60

VServerGroups

object

VServerGroup

array<object>

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

array<object>

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

LoadBalancerId

string

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

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

VServerGroupAttributes

object

VServerGroupAttribute

array<object>

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

object

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

VServerGroupId

string

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

rsp-bp12bjrny****

Weight

integer

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

1

Port

integer

ロードバランサーが外部リクエストを処理するために使用するポート番号。

22

LaunchTemplateOverrides

object

LaunchTemplateOverride

array<object>

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

object

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

WeightedCapacity

integer

インスタンスタイプの重み。スケーリンググループ内のこのタイプの単一インスタンスのキャパシティを表します。重みが高いほど、希望するキャパシティを満たすために必須となるこのタイプのインスタンス数が少なくなります。

4

InstanceType

string

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

ecs.c5.xlarge

SpotPriceLimit

number

起動テンプレートのオーバーライド (LaunchTemplateOverride.N.InstanceType) で指定されたインスタンスタイプの入札価格の最大値。このパラメーターには N 個の値を指定できます。拡張起動テンプレートは N 個のインスタンスタイプをサポートします。N の有効な値: 1~10。

説明

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

0.025

AlbServerGroups

object

AlbServerGroup

array<object>

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

object

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

AlbServerGroupId

string

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

sgp-ddwb0y0g6y9bjm****

Weight

integer

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

100

Port

integer

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

80

ServerGroups

object

ServerGroup

array<object>

ロードバランサーサーバーグループ情報のコレクション。

説明

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

object

ロードバランサーサーバーグループ情報のコレクション。

ServerGroupId

string

サーバーグループの ID。

sgp-i9ouakeaerr*****

Type

string

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

  • ALB: Application Load Balancer (ALB)。

  • NLB: Network Load Balancer (NLB)。

  • GWLB: Gateway Load Balancer (GWLB)。

ALB

Weight

integer

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

100

Port

integer

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

80

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

DBInstanceIds

object

DBInstanceId

array

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

string

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

rm-bp15556qzebg1****

LoadBalancerIds

object

LoadBalancerId

array

スケーリンググループに関連付けられているロードバランサーインスタンスの ID のリスト。

string

スケーリンググループに関連付けられているロードバランサーインスタンスの ID のリスト。

lb-bp19byhscefk3x0li****

VSwitchIds

object

VSwitchId

array

スケーリンググループに関連付けられている vSwitch ID のコレクション。VSwitchIds パラメーターを指定した場合、VSwitchId パラメーターは無視されます。

string

スケーリンググループに関連付けられている vSwitch ID のコレクション。VSwitchIds パラメーターを指定した場合、VSwitchId パラメーターは無視されます。

vsw-bp1whw2u46cn8zubm****

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: スケーリンググループでスケーリングアクティビティが実行されています。

true

MonitorGroupId

string

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

1497****

AzBalance

boolean

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

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

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

説明

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

false

AllocationStrategy

string

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

  • priority: 優先度に基づいて、構成されたインスタンスタイプの注文に従ってインスタンスが作成されます。

  • lowestPrice: インスタンスタイプの vCPU 単価が安い順にインスタンスが作成されます。

説明

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

優先度

SpotAllocationStrategy

string

スポットキャパシティの割り当て戦略。このパラメーターを使用して、スポットキャパシティの割り当て戦略を個別に指定できます。このパラメーターは、MultiAZPolicy が COMPOSABLE にセットされている場合にのみ効果があります。有効な値:

  • priority: 優先度に基づいて、構成されたインスタンスタイプの注文に従ってインスタンスが作成されます。

  • lowestPrice: インスタンスタイプの vCPU 単価が安い順にインスタンスが作成されます。

lowestPrice

MaxInstanceLifetime

integer

スケーリンググループ内にインスタンスが存在できる時間の最大値。単位: 秒。

有効な値: 0 または [86400, Integer.maxValue]。0 を指定すると、以前にセットされた MaxInstanceLifetime の値がクリアされます (MaxInstanceLifetime がセットされていないことを意味します)。

デフォルト値: null。

説明

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

null

CustomPolicyARN

string

カスタムスケールインポリシー用の Function Compute 関数の Alibaba Cloud リソースネーム (ARN)。このパラメーターは、RemovalPolicies の最初の削除ポリシーが CustomPolicy にセットされている場合にのみ効果を発揮します。

acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_ポリシー.LATEST/関数/ess_custom_terminate_ポリシー_name

InitCapacity

integer

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

0

ResourceGroupId

string

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

rg-123****

LoadBalancerConfigs

object

LoadBalancerConfig

array<object>

Classic ロードバランサー (CLB、旧 SLB) インスタンスのロードバランサー構成。

object

Classic ロードバランサー (CLB、旧 SLB) インスタンスのロードバランサー構成。

LoadBalancerId

string

ロードバランサー CLB (旧 SLB) インスタンスの ID。

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

Weight

integer

Auto Scaling によって ECS インスタンスがロードバランサー CLB (旧 SLB) サーバーグループに追加された後の、バックエンドサーバーとしての ECS インスタンスの重み。重みが大きいほど、ECS インスタンスが受信するアクセスリクエストが多くなります。重みが 0 の場合、ECS インスタンスはアクセスリクエストを受信しません。システムは、重みに基づいてアクセスリクエストを割り当てるようになっています。

有効な値: 0 ~ 100。

10

EnableDesiredCapacity

boolean

期待インスタンス数特徴が有効かどうかを示します。有効な値:

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

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

false

Tags

object

Tag

array<object>

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

object

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

TagKey

string

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

部門

TagValue

string

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

財務

Propagate

boolean

タグが伝播可能なタグかどうかを示します。有効な値:

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

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

デフォルト値: false。

false

HealthCheckTypes

object

HealthCheckType

array

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

  • NONE: ヘルスチェックは実行されません。

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

  • LOAD_BALANCER: インスタンスのヘルスステータスは、ロードバランサーのヘルスチェック結果に基づいて決定されます。CLB タイプのロードバランサーはサポートされていません。

string

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

  • NONE: ヘルスチェックは実行されません。

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

  • LOAD_BALANCER: インスタンスのヘルスステータスは、ロードバランサーのヘルスチェック結果に基づいて決定されます。CLB タイプのロードバランサーはサポートされていません。

ECS

DBInstances

object

DBInstance

array<object>

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

array<object>

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

DBInstanceId

string

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

rm-m5eqju85s45mu0***

Type

string

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

  • RDS。

  • Redis。

  • MongoDB。

RDS

SecurityGroupIds

object

SecurityGroupId

array

スケーリンググループがデータベースセキュリティグループのホワイトリストに追加するセキュリティグループのリスト。

string

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

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

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

sg-uf65zt66cf2a0q47***

SpotCapacity

integer

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

0

StopInstanceTimeout

integer

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

60

CapacityOptions

object

容量オプション。

OnDemandBaseCapacity

integer

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

0

OnDemandPercentageAboveBaseCapacity

integer

OnDemandBaseCapacity で指定された従量課金インスタンスの最小値を満たした後の、超過インスタンスにおける従量課金インスタンスの割合。有効な値: 0 ~ 100。

0

CompensateWithOnDemand

boolean

MultiAZPolicy が COST_OPTIMIZED にセットされている場合、コストや在庫不足などの理由でスポットインスタンスを作成できないときに、従量課金 ECS インスタンスを自動的に作成するかどうかを指定します。有効な値:

  • true: 従量課金 ECS インスタンスを作成できます。

  • false: 従量課金 ECS インスタンスを作成できません。

true

SpotAutoReplaceOnDemand

boolean

CompensateWithOnDemand が有効な場合、従量課金の割合が OnDemandPercentageAboveBaseCapacity の割合を超えると、システムは従量課金容量をスポットインスタンスに置き換えようとします。一般的なシナリオは、スポットの在庫や価格の問題により、CompensateWithOnDemand によってスポットインスタンスが従量課金インスタンスにダウングレードされる場合です。従量課金インスタンスが長期間存続するのを防ぐため、システムは超過した従量課金容量をスポットインスタンスに置き換えようとします。有効な値:

  • true: 許可。

  • false: 不許可。

false

PriceComparisonMode

string

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

  • PricePerUnit: 容量の単位あたりの価格に基づいて価格を比較します。

    スケーリンググループ内のインスタンスの容量は、インスタンスタイプに対して設定された重みに等しくなります。デフォルトの重みは 1 で、1 つの ECS インスタンスが 1 の容量を占有することを意味します。

  • PricePerVCpu: vCPU あたりの価格に基づいて価格を比較します。

デフォルト値: PricePerUnit。

PricePerUnit

BalanceMode

string

ゾーンバランシングモード。このパラメーターは、ゾーンバランシングが有効な場合にのみ効果を発揮します。有効な値:

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

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

BalancedBestEffort

AutoRebalance

boolean

スケーリンググループで自動リバランスが有効かどうかを示します。このパラメーターは、ゾーンバランス型スケーリンググループで BalancedOnly が有効な場合にのみ効果を発揮します。有効な値:

  • false: スケーリンググループで自動リバランスは有効になっていません。

  • true: 自動リバランスが有効な場合、スケーリンググループはゾーン間の容量を自動的に検出します。ゾーン容量が不均衡な場合、スケーリンググループはゾーン間でスケールアウトおよびスケールインのアクティブな操作を実行し、ゾーン容量をリバランスします。

false

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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