スケーリンググループの基本情報、インスタンス、スケーリング設定などの情報をクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ess:DescribeScalingGroups |
get |
*ScalingGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
スケーリンググループが配置されているリージョン ID です。 |
cn-qingdao |
| PageNumber |
integer |
任意 |
ページ番号です。ページは 1 から始まります。 デフォルト値:1 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数です。最大値:50 デフォルト値:10 |
10 |
| GroupType |
string |
任意 |
スケーリンググループで管理されるインスタンスのタイプです。有効な値:
|
ECS |
| ScalingGroupIds |
array |
任意 |
クエリ対象のスケーリンググループ ID です。 非アクティブなスケーリンググループの ID はクエリ結果に含まれず、エラーも返されません。 |
|
|
string |
任意 |
クエリ対象のスケーリンググループ ID です。 非アクティブなスケーリンググループの ID はクエリ結果に表示されず、エラーも返されません。 |
asg-bp14wlu85wrpchm0**** |
|
| ScalingGroupNames |
array |
任意 |
クエリ対象のスケーリンググループ名です。 非アクティブなスケーリンググループの名前はクエリ結果に表示されず、エラーも報告されません。 |
|
|
string |
任意 |
クエリ対象のスケーリンググループ名です。 非アクティブなスケーリンググループの名前はクエリ結果に表示されず、エラーも報告されません。 |
scalinggroup**** |
|
| ScalingGroupName |
string |
任意 |
スケーリンググループの名前です。 |
scalinggroup**** |
| ResourceGroupId |
string |
任意 |
クエリ対象のスケーリンググループが属するリソースグループの ID です。 説明
指定されたリソースグループにスケーリンググループが存在しない場合、クエリ結果は空となり、エラーは報告されません。 |
rg-123****** |
| Tags |
array<object> |
任意 |
スケーリンググループのタグです。 |
|
|
object |
任意 |
スケーリンググループのタグです。 |
||
| Key |
string |
任意 |
スケーリンググループのタグキーです。 |
Department |
| Value |
string |
任意 |
スケーリンググループのタグ値です。 |
Finance |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
スケーリンググループリストの詳細情報です。 |
||
| RequestId |
string |
リクエスト ID です。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| PageNumber |
integer |
ページ番号です。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数です。 |
10 |
| TotalCount |
integer |
返されたエントリの総数です。 |
1 |
| ScalingGroups |
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 |
スケーリンググループ内のインスタンスタイプ数です。Auto Scaling は、スケーリンググループのゾーン全体で最も低価格で提供されている複数のインスタンスタイプのプリエンプティブルインスタンスを均等に作成します。有効な値:0~10 |
5 |
| StoppedCapacity |
integer |
スケーリンググループ内で節約モードにより停止されたインスタンス数です。 |
1 |
| OnDemandPercentageAboveBaseCapacity |
integer |
従量課金インスタンスの最小数がしきい値に達した後の超過分における従量課金インスタンスの割合です。有効な値:0~100 |
20 |
| ModificationTime |
string |
スケーリンググループが最後に変更された時刻です。 |
2014-08-14T10:58Z |
| MinSize |
integer |
スケーリンググループに含まれる必要がある ECS インスタンスの最小数です。 |
1 |
| ScalingGroupId |
string |
スケーリンググループの ID です。 |
asg-bp14wlu85wrpchm0**** |
| CompensateWithOnDemand |
boolean |
MultiAZPolicy が COST_OPTIMIZED に設定されている場合、価格要因または在庫不足によりプリエンプティブルインスタンスを作成できないときに、Auto Scaling が従量課金インスタンスを作成して補完できるかどうかを示します。有効な値:
|
true |
| ScalingPolicy |
string |
スケーリンググループのインスタンス回収モードです。有効な値:
詳細については、「RemoveInstances」をご参照ください。 |
recycle |
| RemovingWaitCapacity |
integer |
スケーリンググループ内で削除待ち状態にある ECS インスタンス数です。 |
1 |
| ActiveCapacity |
integer |
スケーリンググループ内でサービス中状態にある ECS インスタンス数です。 |
1 |
| OnDemandBaseCapacity |
integer |
スケーリンググループに含まれる必要がある従量課金インスタンスの最小数です。有効な値:0~1000。従量課金インスタンスの数がこのパラメーターの値未満の場合、Auto Scaling は優先的に従量課金インスタンスを作成します。 |
30 |
| ProtectedCapacity |
integer |
スケーリンググループ内で保護状態にある ECS インスタンス数です。 |
1 |
| HealthCheckType |
string |
スケーリンググループのヘルスチェックモードです。有効な値:
|
ECS |
| LifecycleState |
string |
スケーリンググループのステータスです。有効な値:
|
Active |
| GroupDeletionProtection |
boolean |
スケーリンググループに対して削除保護機能が有効かどうかを示します。有効な値:
|
true |
| ActiveScalingConfigurationId |
string |
スケーリンググループ内のアクティブなスケーリング設定の ID です。 |
asc-bp1et2qekq3ojr33**** |
| GroupType |
string |
スケーリンググループで管理されるインスタンスのタイプです。 |
ECS |
| MultiAZPolicy |
string |
マルチゾーンスケーリンググループ内の ECS インスタンスのスケーリングポリシーです。有効な値:
|
PRIORITY |
| RemovingCapacity |
integer |
スケーリンググループから削除中の ECS インスタンス数です。 |
0 |
| PendingWaitCapacity |
integer |
スケーリンググループ内で追加待ち状態にある ECS インスタンス数です。 |
1 |
| StandbyCapacity |
integer |
スケーリンググループ内でスタンバイ状態にある ECS インスタンス数です。 |
1 |
| CurrentHostName |
string |
説明
このパラメーターは使用できません。 |
hostname |
| PendingCapacity |
integer |
スケーリンググループに追加中かつ構成中の ECS インスタンス数です。 |
0 |
| LaunchTemplateId |
string |
スケーリンググループで使用される起動テンプレートの ID です。 |
lt-m5e3ofjr1zn1aw7**** |
| TotalCapacity |
integer |
Weighted が指定されている場合、このパラメーターはスケーリンググループ内のすべての ECS インスタンスの重み付き総容量を示します。それ以外の場合は、スケーリンググループ内の ECS インスタンスの総数を示します。 |
1 |
| DesiredCapacity |
integer |
スケーリンググループ内の期待される ECS インスタンス数です。Auto Scaling は自動的に期待される ECS インスタンス数を維持します。 |
5 |
| SpotInstanceRemedy |
boolean |
プリエンプティブルインスタンスを補完できるかどうかを示します。このパラメーターが true に設定されている場合、Auto Scaling はシステム通知を受信すると、回収対象のプリエンプティブルインスタンスを置き換えるために積極的にインスタンスを作成します。 |
true |
| LaunchTemplateVersion |
string |
スケーリンググループで使用される起動テンプレートのバージョンです。 |
Default |
| RegionId |
string |
スケーリンググループのリージョン ID です。 |
cn-qingdao |
| VSwitchId |
string |
スケーリンググループの vSwitch ID です。 |
vsw-bp1whw2u46cn8zubm**** |
| MaxSize |
integer |
スケーリンググループに含まれる ECS インスタンスの最大数です。 |
2 |
| DefaultCooldown |
integer |
スケーリンググループのクールダウン期間です。クールダウン期間中、Auto Scaling は CloudMonitor の監視タスクによってトリガーされたスケーリングアクティビティを実行しません。 |
60 |
| VServerGroups |
array<object> |
バックエンド vServer グループです。 |
|
|
array<object> |
バックエンド vServer グループです。 |
||
| LoadBalancerId |
string |
バックエンド vServer グループが属するロードバランサーの ID です。 |
147b46d767c-cn-qingdao-cm5**** |
| VServerGroupAttributes |
array<object> |
バックエンド vServer グループの属性です。 |
|
|
object |
バックエンド vServer グループの属性です。 |
||
| VServerGroupId |
string |
バックエンド vServer グループの ID です。 |
rsp-bp12bjrny**** |
| Weight |
integer |
バックエンド vServer グループの重みです。 |
1 |
| Port |
integer |
ロードバランサーが外部サービスを提供するために使用するポート番号です。 |
22 |
| LaunchTemplateOverrides |
array<object> |
起動テンプレートで拡張されたインスタンスタイプです。 |
|
|
object |
起動テンプレートで拡張されたインスタンスタイプです。 |
||
| WeightedCapacity |
integer |
インスタンスタイプの重みです。このパラメーターの値は、スケーリンググループ内の指定されたインスタンスタイプの単一インスタンスの容量を示します。重みが大きいほど、期待される容量を満たすために必要な指定されたインスタンスタイプのインスタンス数は少なくなります。 |
4 |
| InstanceType |
string |
インスタンスタイプです。このパラメーターで指定されたインスタンスタイプは、起動テンプレートで指定されたインスタンスタイプをオーバーライドします。 |
ecs.c5.xlarge |
| SpotPriceLimit |
number |
説明
このパラメーターは、 |
0.025 |
| AlbServerGroups |
array<object> |
Application Load Balancer (ALB) サーバーグループです。 |
|
|
object |
ALB サーバーグループです。 |
||
| AlbServerGroupId |
string |
ALB サーバーグループの ID です。 |
sgp-ddwb0y0g6y9bjm**** |
| Weight |
integer |
ECS インスタンスが ALB サーバーグループのバックエンドサーバーとして機能する際の重みです。 |
100 |
| Port |
integer |
ECS インスタンスが ALB サーバーグループのバックエンドサーバーとして機能する際に使用するポート番号です。 |
80 |
| ServerGroups |
array<object> |
サーバーグループに関する情報です。 説明
このパラメーターを使用して、スケーリンググループに関連付けられた ALB、NLB、GWLB サーバーグループの情報を取得できます。 |
|
|
object |
サーバーグループ情報です。 |
||
| ServerGroupId |
string |
サーバーグループの ID です。 |
sgp-i9ouakeaerr***** |
| Type |
string |
サーバーグループのタイプです。有効な値:
|
ALB |
| Weight |
integer |
ECS インスタンスがサーバーグループのバックエンドサーバーとして機能する際の重みです。 |
100 |
| Port |
integer |
サーバーグループ内の各 ECS インスタンスが使用するポート番号です。 |
80 |
| RemovalPolicies |
array |
インスタンス削除ポリシーです。有効な値:
|
|
|
string |
インスタンス削除ポリシーです。有効な値:
|
OldestScalingConfiguration |
|
| DBInstanceIds |
array |
スケーリンググループにアタッチされている ApsaraDB RDS インスタンスの ID です。 |
|
|
string |
スケーリンググループにアタッチされている ApsaraDB RDS インスタンスの ID です。 |
rm-bp15556qzebg1**** |
|
| LoadBalancerIds |
array |
スケーリンググループにアタッチされているロードバランサーの ID です。 |
|
|
string |
スケーリンググループにアタッチされているロードバランサーの ID です。 |
lb-bp19byhscefk3x0li**** |
|
| VSwitchIds |
array |
スケーリンググループに関連付けられている vSwitch の ID です。VSwitchIds を指定した場合、VSwitchId は無視されます。 |
|
|
string |
スケーリンググループに関連付けられている vSwitch の ID です。VSwitchIds を指定した場合、VSwitchId は無視されます。 |
vsw-bp1whw2u46cn8zubm**** |
|
| SuspendedProcesses |
array |
一時停止されているプロセスです。プロセスが一時停止されていない場合、null が返されます。有効な値:
|
|
|
string |
一時停止されているプロセスです。プロセスが一時停止されていない場合、null が返されます。有効な値:
|
ScaleIn |
|
| SystemSuspended |
boolean |
Auto Scaling がスケーリンググループ内のスケーリングアクティビティの実行を停止するかどうかを示します。有効な値:
|
true |
| IsElasticStrengthInAlarm |
boolean |
説明
このパラメーターは使用できません。 |
false |
| MonitorGroupId |
string |
スケーリンググループに関連付けられている CloudMonitor アプリケーショングループの ID です。 |
1497**** |
| AzBalance |
boolean |
スケーリンググループ内のインスタンスが指定されたゾーン間で均等に分散されているかどうかを示します。このパラメーターは、
|
false |
| AllocationStrategy |
string |
インスタンス割り当てポリシーです。Auto Scaling は、割り当てポリシーに基づいてインスタンスタイプを選択し、必要な数のプリエンプティブルインスタンスを作成します。このポリシーは、従量課金インスタンスおよびプリエンプティブルインスタンスに適しています。このパラメーターは、
|
priority |
| SpotAllocationStrategy |
string |
プリエンプティブルインスタンスの割り当てポリシーです。このパラメーターは、Auto Scaling がインスタンスタイプを選択して必要な数のプリエンプティブルインスタンスを作成する方法を示します。このパラメーターは、
デフォルト値:priority |
lowestPrice |
| MaxInstanceLifetime |
integer |
スケーリンググループ内の各 ECS インスタンスの最大ライフサイクルです。単位:秒。 有効な値:0 または デフォルト値:null 説明
このパラメーターは、Elastic Container Instance タイプのスケーリンググループおよび ScalingPolicy が Recycle に設定されているスケーリンググループではサポートされていません。 |
null |
| CustomPolicyARN |
string |
カスタムスケールインポリシーで指定された関数の Alibaba Cloud リソースネーム (ARN) です。このパラメーターは、RemovalPolicies の最初の値を CustomPolicy に設定した場合にのみ有効です。 |
acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name |
| InitCapacity |
integer |
スケーリンググループに追加される前に初期化されるインスタンス数です。 |
0 |
| ResourceGroupId |
string |
スケーリンググループが属するリソースグループの ID です。 |
rg-123**** |
| LoadBalancerConfigs |
array<object> |
ロードバランサーの設定です。 |
|
|
object |
ロードバランサーの設定です。 |
||
| LoadBalancerId |
string |
CLB インスタンスの ID です。 |
lb-2zep8alpq5zq1a2xwyxxx |
| Weight |
integer |
ECS インスタンスが CLB サーバーグループのバックエンドサーバーとして機能する際の重みです。ECS インスタンスの重みを増やすと、その ECS インスタンスに転送されるアクセスリクエストの数が増えます。ECS インスタンスの重みを 0 に設定すると、アクセスリクエストはその ECS インスタンスに転送されません。有効な値:0~100 |
10 |
| EnableDesiredCapacity |
boolean |
期待インスタンス数機能が有効かどうかを示します。有効な値:
|
false |
| Tags |
array<object> |
スケーリンググループのタグです。 |
|
|
object |
スケーリンググループのタグです。 |
||
| TagKey |
string |
スケーリンググループのタグキーです。 |
Department |
| TagValue |
string |
スケーリンググループのタグ値です。 |
Finance |
| Propagate |
boolean |
スケーリンググループのタグをインスタンスに伝播できるかどうかを示します。有効な値:
デフォルト値:false |
false |
| HealthCheckTypes |
array |
スケーリンググループのヘルスチェックモードです。有効な値:
|
|
|
string |
スケーリンググループのヘルスチェックモードです。有効な値:0~1024
|
ECS |
|
| DBInstances |
array<object> |
スケーリンググループにアタッチされているデータベースです。 |
|
|
object |
スケーリンググループにアタッチされているデータベースです。 |
||
| DBInstanceId |
string |
データベースの ID です。 |
rm-m5eqju85s45mu0*** |
| Type |
string |
データベースのタイプです。有効な値:
|
RDS |
| SecurityGroupIds |
array |
アタッチされたデータベースのセキュリティグループホワイトリストに追加されるセキュリティグループの ID です。 |
|
|
string |
アタッチされたデータベースのセキュリティグループホワイトリストに追加されるセキュリティグループの ID です。 DetachDBInstances 操作で |
sg-uf65zt66cf2a0q47*** |
|
| SpotCapacity |
integer |
スケーリンググループ内のプリエンプティブルインスタンス数です。 |
0 |
| StopInstanceTimeout |
integer |
スケールインプロセス中に Elastic Compute Service (ECS) インスタンスが停止状態になるまでに必要な時間です。単位:秒。 |
60 |
| CapacityOptions |
object |
容量オプションです。 |
|
| OnDemandBaseCapacity |
integer |
スケーリンググループに必要な従量課金インスタンスの最小数です。従量課金インスタンスの実際の数が最小しきい値を下回った場合、Auto Scaling は優先的に従量課金インスタンスを作成します。有効な値:0~1000 |
0 |
| OnDemandPercentageAboveBaseCapacity |
integer |
従量課金インスタンスの最小数に達した後の超過インスタンスにおける従量課金インスタンスの割合です。 |
0 |
| CompensateWithOnDemand |
boolean |
高価格またはリソースの在庫不足によりプリエンプティブル ECS インスタンスを作成できない場合に、必要な ECS インスタンス数を満たすために従量課金 ECS インスタンスを自動的に作成できるかどうかを示します。このパラメーターは、
|
true |
| SpotAutoReplaceOnDemand |
boolean |
従量課金 ECS インスタンスをプリエンプティブル ECS インスタンスに置き換えるかどうかを指定します。
|
false |
| PriceComparisonMode |
string |
価格の比較方法を示します。有効な値:
|
PricePerUnit |
| BalanceMode |
string |
ゾーンバランスモードです。このモードは、ゾーンバランスモードが有効になっている場合にのみ有効です。有効な値:
|
BalancedBestEffort |
| AutoRebalance |
boolean |
スケーリンググループの自動リバランスを有効にするかどうかを示します。これは、スケーリンググループに対して BalancedOnly が有効になっている場合にのみ有効です。有効な値:
|
false |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"ScalingGroups": [
{
"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,
"CurrentHostName": "hostname",
"PendingCapacity": 0,
"LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
"TotalCapacity": 1,
"DesiredCapacity": 5,
"SpotInstanceRemedy": true,
"LaunchTemplateVersion": "Default",
"RegionId": "cn-qingdao",
"VSwitchId": "vsw-bp1whw2u46cn8zubm****",
"MaxSize": 2,
"DefaultCooldown": 60,
"VServerGroups": [
{
"LoadBalancerId": "147b46d767c-cn-qingdao-cm5****",
"VServerGroupAttributes": [
{
"VServerGroupId": "rsp-bp12bjrny****",
"Weight": 1,
"Port": 22
}
]
}
],
"LaunchTemplateOverrides": [
{
"WeightedCapacity": 4,
"InstanceType": "ecs.c5.xlarge",
"SpotPriceLimit": 0.025
}
],
"AlbServerGroups": [
{
"AlbServerGroupId": "sgp-ddwb0y0g6y9bjm****",
"Weight": 100,
"Port": 80
}
],
"ServerGroups": [
{
"ServerGroupId": "sgp-i9ouakeaerr*****",
"Type": "ALB",
"Weight": 100,
"Port": 80
}
],
"RemovalPolicies": [
"OldestScalingConfiguration"
],
"DBInstanceIds": [
"rm-bp15556qzebg1****"
],
"LoadBalancerIds": [
"lb-bp19byhscefk3x0li****"
],
"VSwitchIds": [
"vsw-bp1whw2u46cn8zubm****"
],
"SuspendedProcesses": [
"ScaleIn"
],
"SystemSuspended": true,
"IsElasticStrengthInAlarm": false,
"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": [
{
"LoadBalancerId": "lb-2zep8alpq5zq1a2xwyxxx",
"Weight": 10
}
],
"EnableDesiredCapacity": false,
"Tags": [
{
"TagKey": "Department",
"TagValue": "Finance",
"Propagate": false
}
],
"HealthCheckTypes": [
"ECS"
],
"DBInstances": [
{
"DBInstanceId": "rm-m5eqju85s45mu0***\n",
"Type": "RDS",
"SecurityGroupIds": [
"sg-uf65zt66cf2a0q47***"
]
}
],
"SpotCapacity": 0,
"StopInstanceTimeout": 60,
"CapacityOptions": {
"OnDemandBaseCapacity": 0,
"OnDemandPercentageAboveBaseCapacity": 0,
"CompensateWithOnDemand": true,
"SpotAutoReplaceOnDemand": false,
"PriceComparisonMode": "PricePerUnit"
},
"BalanceMode": "BalancedBestEffort",
"AutoRebalance": false
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。