スケーリンググループをクエリします。DescribeScalingGroupDetail 操作を呼び出すことで、スケーリンググループの基本情報、インスタンス、およびスケーリング設定を取得できます。Elastic Container Instance タイプのスケーリンググループで OutputFormat を YAML に設定した場合、出力は YAML フォーマットの Kubernetes Deployment ファイルになります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ess:DescribeScalingGroupDetail |
get |
*ScalingGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
スケーリンググループが属するリージョン ID。詳細については、「リージョンとゾーン」をご参照ください。 |
cn-hangzhou |
| ScalingGroupId |
string |
必須 |
スケーリンググループの ID。 |
asg-bp18p2yfxow2dloq**** |
| OutputFormat |
string |
任意 |
出力フォーマットです。値を yaml に設定してください。 |
YAML |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID です。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| ScalingGroup |
object |
スケーリンググループです。 |
|
| VpcId |
string |
スケーリンググループの仮想プライベートクラウド (VPC) ID です。 |
vpc-wz9fcq97y1vqkd8bijcq6 |
| CreationTime |
string |
スケーリンググループが作成された時刻です。 |
2014-08-14T10:58Z |
| TotalInstanceCount |
integer |
スケーリンググループ内の Elastic Compute Service (ECS) インスタンスの総数です。 |
1 |
| ScalingGroupName |
string |
スケーリンググループの名前です。各スケーリンググループの名前は、リージョン内で一意である必要があります。 名前は 2~64 文字で、文字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.) を使用できます。先頭は文字または数字である必要があります。 |
dyrSuvBOtO1dEdIlIbp**** |
| SpotInstancePools |
integer |
指定されたインスタンスタイプの数です。最も価格の低い複数のインスタンスタイプのプリエンプティブルインスタンスは、スケーリンググループのゾーンに均等に分散されます。有効な値: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 |
価格の高騰やリソースの在庫不足によりプリエンプティブル ECS インスタンスを作成できない場合に、従量課金の ECS インスタンスを自動的に作成して、必要な ECS インスタンス数に達することができるかどうかを示します。このパラメータは、
|
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 インスタンスの数です。 |
0 |
| StandbyCapacity |
integer |
スケーリンググループ内でスタンバイ状態にある ECS インスタンスの数です。 |
1 |
| CurrentHostName |
string |
説明
このパラメータは使用できません。 |
hostname |
| PendingCapacity |
integer |
スケーリンググループに追加中で設定中の ECS インスタンスの数です。 |
0 |
| LaunchTemplateId |
string |
スケーリンググループで使用される起動テンプレートの ID です。 |
lt-m5e3ofjr1zn1aw7**** |
| TotalCapacity |
integer |
|
1 |
| DesiredCapacity |
integer |
スケーリンググループで希望する ECS インスタンス数です。Auto Scaling は、希望する ECS インスタンス数を自動的に維持します。 |
5 |
| SpotInstanceRemedy |
boolean |
プリエンプティブルインスタンスを補充できるかどうかを示します。このパラメータを true に設定すると、Auto Scaling はプリエンプティブルインスタンスが回収されることを示すシステムメッセージを受信したときに、インスタンスを作成してプリエンプティブルインスタンスを置き換えます。 |
true |
| LaunchTemplateVersion |
string |
起動テンプレートのバージョン番号です。 |
Default |
| RegionId |
string |
スケーリンググループのリージョン ID です。 |
cn-shenzhen |
| VSwitchId |
string |
スケーリンググループの vSwitch ID です。 |
vsw-bp1whw2u46cn8zubm**** |
| MaxSize |
integer |
スケーリンググループに含めることができる ECS インスタンスの最大数です。 |
2 |
| DefaultCooldown |
integer |
スケーリンググループのクールダウン期間です。単位:秒。 |
60 |
| VServerGroups |
array<object> |
バックエンド vServer グループです。 |
|
|
array<object> |
|||
| LoadBalancerId |
string |
バックエンド vServer グループが属するクラシックロードバランサー (CLB、旧称 Server Load Balancer または SLB) インスタンスの ID です。 |
147b46d767c-cn-qingdao-cm5**** |
| VServerGroupAttributes |
array<object> |
バックエンド vServer グループの属性です。 |
|
|
object |
|||
| VServerGroupId |
string |
バックエンド vServer グループの ID です。 |
rsp-bp12bjrny**** |
| Weight |
integer |
バックエンド vServer グループの重みです。 |
1 |
| Port |
integer |
バックエンド vServer のポート番号です。 |
80 |
| LaunchTemplateOverrides |
array<object> |
起動テンプレートで拡張されたインスタンスタイプに関する情報です。 |
|
|
object |
|||
| WeightedCapacity |
integer |
インスタンスタイプの重みです。このパラメータの値は、指定されたインスタンスタイプのインスタンスがスケーリンググループ内で持つキャパシティを示します。重みが大きいほど、希望するキャパシティ要件を満たすために必要な、指定されたインスタンスタイプのインスタンス数が少なくなります。 |
4 |
| InstanceType |
string |
インスタンスタイプです。このパラメータで指定されたインスタンスタイプは、起動テンプレートのインスタンスタイプを上書きします。 |
ecs.c5.xlarge |
| SpotPriceLimit |
number |
説明
このパラメータは、 |
0.025 |
| AlbServerGroups |
array<object> |
Application Load Balancer (ALB) サーバーグループに関する情報です。 |
|
|
object |
|||
| AlbServerGroupId |
string |
Application Load Balancer (ALB) サーバーグループの ID です。 |
sgp-ddwb0y0g6y9bjm**** |
| Weight |
integer |
ALB サーバーグループのバックエンドサーバーとしての ECS インスタンスの重みです。 |
100 |
| Port |
integer |
ALB サーバーグループのバックエンドサーバーとして ECS インスタンスが使用するポート番号です。 |
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 |
スケーリンググループに関連付けられているクラシックロードバランサー (CLB) インスタンスの ID です。 |
|
|
string |
スケーリンググループに関連付けられているクラシックロードバランサー (CLB) インスタンスの ID です。 |
lb-bp19byhscefk3x0li**** |
|
| VSwitchIds |
array |
スケーリンググループに関連付けられている vSwitch の ID です。 |
|
|
string |
スケーリンググループに関連付けられている vSwitch の ID です。 |
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 は、配分ポリシーに基づいてインスタンスタイプを選択し、必要な数のプリエンプティブルインスタンスを作成します。このポリシーは、従量課金インスタンスとプリエンプティブルインスタンスに適用できます。このパラメータは、
|
lowestPrice |
| MaxInstanceLifetime |
integer |
スケーリンググループ内のインスタンスの最大存続期間です。単位:秒。 有効な値:0 または 86400 から デフォルト値:null。 説明
このパラメータは、弾性コンテナインスタンスタイプのスケーリンググループ、および |
null |
| CustomPolicyARN |
string |
カスタムスケールインポリシーで指定された関数の Alibaba Cloud リソースネーム (ARN) です。このパラメータは、 |
null |
| InitCapacity |
integer |
初期化済み状態で、スケーリンググループに追加されていないインスタンスの数です。 |
0 |
| ResourceGroupId |
string |
スケーリンググループが属するリソースグループの ID です。 説明
このパラメータを指定すると、新しいスケーリンググループは指定されたリソースグループに追加されます。このパラメータを指定しない場合、新しいスケーリンググループはデフォルトのリソースグループに追加されます。 |
rg-aek2epf32c4uyji |
| LoadBalancerConfigs |
array<object> |
CLB 設定です。 |
|
|
object |
|||
| LoadBalancerId |
string |
CLB インスタンスの ID です。 |
lb-2zein3ytoeq49cmkbyxr0 |
| Weight |
integer |
バックエンドサーバーの重みです。 |
100 |
| EnableDesiredCapacity |
boolean |
希望するインスタンス数機能が有効になっているかどうかを示します。有効な値:
|
true |
| Tags |
array<object> |
スケーリンググループのタグです。 |
|
|
object |
|||
| TagKey |
string |
スケーリンググループのタグキーです。 |
Department |
| TagValue |
string |
スケーリンググループのタグ値です。 |
Finance |
| Propagate |
boolean |
スケーリンググループのタグをインスタンスに伝播できるかどうかを示します。有効な値:
デフォルト値:false。 |
false |
| HealthCheckTypes |
array |
スケーリンググループのヘルスチェックモードです。有効な値:
|
|
|
string |
スケーリンググループのヘルスチェックモードです。有効な値:
|
ECS |
|
| Output |
string |
弾性コンテナインスタンスタイプのスケーリンググループの出力詳細です。現在、出力は Kubernetes Deployment YAML ファイルで表示されます。 |
apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment labels: app: nginx spec: replicas: 3 selector: matchLabels: app: nginx template: metadata: labels: app: nginx annotations: k8s.aliyun.com/eip-bandwidth: 10 k8s.aliyun.com/eci-with-eip: true spec: containers: - name: nginx image: nginx:1.14.2 ports: - containerPort: 80 |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ScalingGroup": {
"VpcId": "vpc-wz9fcq97y1vqkd8bijcq6",
"CreationTime": "2014-08-14T10:58Z\n",
"TotalInstanceCount": 1,
"ScalingGroupName": "dyrSuvBOtO1dEdIlIbp****\n",
"SpotInstancePools": 5,
"StoppedCapacity": 1,
"OnDemandPercentageAboveBaseCapacity": 20,
"ModificationTime": "2014-08-14T10:58Z\n",
"MinSize": 1,
"ScalingGroupId": "asg-bp14wlu85wrpchm0****\n",
"CompensateWithOnDemand": true,
"ScalingPolicy": "recycle",
"RemovingWaitCapacity": 1,
"ActiveCapacity": 1,
"OnDemandBaseCapacity": 30,
"ProtectedCapacity": 1,
"HealthCheckType": "ECS",
"LifecycleState": "Active",
"GroupDeletionProtection": true,
"ActiveScalingConfigurationId": "asc-bp1et2qekq3ojr33****\n",
"GroupType": "ECS",
"MultiAZPolicy": "PRIORITY",
"RemovingCapacity": 0,
"PendingWaitCapacity": 0,
"StandbyCapacity": 1,
"CurrentHostName": "hostname",
"PendingCapacity": 0,
"LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****\n",
"TotalCapacity": 1,
"DesiredCapacity": 5,
"SpotInstanceRemedy": true,
"LaunchTemplateVersion": "Default",
"RegionId": "cn-shenzhen",
"VSwitchId": "vsw-bp1whw2u46cn8zubm****\n",
"MaxSize": 2,
"DefaultCooldown": 60,
"VServerGroups": [
{
"LoadBalancerId": "147b46d767c-cn-qingdao-cm5****\n",
"VServerGroupAttributes": [
{
"VServerGroupId": "rsp-bp12bjrny****\n",
"Weight": 1,
"Port": 80
}
]
}
],
"LaunchTemplateOverrides": [
{
"WeightedCapacity": 4,
"InstanceType": "ecs.c5.xlarge\n",
"SpotPriceLimit": 0.025
}
],
"AlbServerGroups": [
{
"AlbServerGroupId": "sgp-ddwb0y0g6y9bjm****\n",
"Weight": 100,
"Port": 80
}
],
"ServerGroups": [
{
"ServerGroupId": "sgp-i9ouakeaerr*****\n",
"Type": "ALB",
"Weight": 100,
"Port": 80
}
],
"RemovalPolicies": [
"OldestScalingConfiguration"
],
"DBInstanceIds": [
"rm-bp15556qzebg1****\n"
],
"LoadBalancerIds": [
"lb-bp19byhscefk3x0li****\n"
],
"VSwitchIds": [
"vsw-bp1whw2u46cn8zubm****\n"
],
"SuspendedProcesses": [
"ScaleIn"
],
"SystemSuspended": true,
"IsElasticStrengthInAlarm": false,
"MonitorGroupId": "1497****\n",
"AzBalance": false,
"AllocationStrategy": "priority",
"SpotAllocationStrategy": "lowestPrice",
"MaxInstanceLifetime": 0,
"CustomPolicyARN": "null",
"InitCapacity": 0,
"ResourceGroupId": "rg-aek2epf32c4uyji",
"LoadBalancerConfigs": [
{
"LoadBalancerId": "lb-2zein3ytoeq49cmkbyxr0",
"Weight": 100
}
],
"EnableDesiredCapacity": true,
"Tags": [
{
"TagKey": "Department",
"TagValue": "Finance",
"Propagate": false
}
],
"HealthCheckTypes": [
"ECS"
]
},
"Output": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: nginx-deployment\n labels:\n app: nginx\n spec:\n replicas: 3\n selector:\n matchLabels:\n app: nginx\n template:\n metadata:\n labels:\n app: nginx\n annotations:\n k8s.aliyun.com/eip-bandwidth: 10\n k8s.aliyun.com/eci-with-eip: true\n spec:\n containers:\n - name: nginx\n image: nginx:1.14.2\n ports:\n - containerPort: 80"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。