如果您需要查看伸缩组的基本信息、伸缩组内实例、伸缩配置等信息,您可以通过调用API DescribeScalingGroups查询该伸缩组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ess:DescribeScalingGroups |
get |
*ScalingGroup
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
伸缩组所属地域的 ID。 |
cn-qingdao |
| PageNumber |
integer |
否 |
伸缩组列表的页码。起始值:1。 默认值:1。 |
1 |
| PageSize |
integer |
否 |
分页查询时设置的每页行数。最大值: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 |
每页行数。 |
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 |
指定可用实例规格的个数,伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围:0~10。 |
5 |
| StoppedCapacity |
integer |
伸缩组中处于节省停机效果的实例数量。 |
1 |
| OnDemandPercentageAboveBaseCapacity |
integer |
伸缩组满足最小按量实例数(ondemandbasecapacity)要求后,超出的实例中按量实例应占的比例,取值范围:0~100。 |
20 |
| ModificationTime |
string |
修改时间。 |
2014-08-14T10:58Z |
| MinSize |
integer |
伸缩组内 ECS 实例台数的最小值。 |
1 |
| ScalingGroupId |
string |
伸缩组的 ID。 |
asg-bp14wlu85wrpchm0**** |
| CompensateWithOnDemand |
boolean |
当 MultiAZPolicy 取值为 COST_OPTIMIZED 时,如果因价格、库存等原因无法创建足够的抢占式实例,是否允许自动尝试创建按量实例满足 ECS 实例数量要求。可能值:
|
true |
| ScalingPolicy |
string |
指定伸缩组的回收模式。可能值:
关于被移出实例的动作,请参见 RemoveInstances 。 |
recycle |
| RemovingWaitCapacity |
integer |
伸缩组中处于移除挂起状态的 ECS 实例的数量。 |
1 |
| ActiveCapacity |
integer |
已成功加入伸缩组,并正常运行的 ECS 实例数量。 |
1 |
| OnDemandBaseCapacity |
integer |
已有伸缩组内所需要的按量实例数的最小值,取值范围:0~1000。即当伸缩组内按量实例个数少于该最小值时,系统将优先创建按量实例。 |
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 |
伸缩组中处于备用状态的实例数量。 |
1 |
| CurrentHostName |
string |
说明
该参数未开放使用。 |
hostname |
| PendingCapacity |
integer |
正在加入伸缩组,还未完成相关配置的 ECS 实例的数量。 |
0 |
| LaunchTemplateId |
string |
伸缩组使用的实例启动模板的 ID。 |
lt-m5e3ofjr1zn1aw7**** |
| TotalCapacity |
integer |
当伸缩组设置了实例规格权重,表示伸缩组内所有 ECS 实例的加权容量总和。否则,表示伸缩组内所有 ECS 实例的数量 |
1 |
| DesiredCapacity |
integer |
伸缩组内 ECS 实例的期望数量,伸缩组会自动将 ECS 实例数量维持在期望实例数。 |
5 |
| SpotInstanceRemedy |
boolean |
是否开启补齐抢占式实例。开启后,当收到抢占式实例将被回收的系统消息时,伸缩组将尝试创建新的实例,替换掉将被回收的抢占式实例。 |
true |
| LaunchTemplateVersion |
string |
伸缩组使用的实例启动模板的版本。 |
Default |
| RegionId |
string |
伸缩组所属的地域的 ID。 |
cn-qingdao |
| VSwitchId |
string |
伸缩组关联虚拟交换机的 ID。 |
vsw-bp1whw2u46cn8zubm**** |
| MaxSize |
integer |
伸缩组内 ECS 实例台数的最大值。 |
2 |
| DefaultCooldown |
integer |
伸缩组默认的冷却时间。冷却时间内,该伸缩组不执行其它的伸缩活动,仅针对云监控报警任务触发的伸缩活动有效。 |
60 |
| VServerGroups |
array<object> |
后端服务器组列表。 |
|
|
array<object> |
后端服务器组列表。 |
||
| LoadBalancerId |
string |
后端服务器组所属的负载均衡实例的 ID。 |
147b46d767c-cn-qingdao-cm5**** |
| VServerGroupAttributes |
array<object> |
后端服务器组属性。 |
|
|
object |
后端服务器组属性。 |
||
| VServerGroupId |
string |
后端服务器组属性。 |
rsp-bp12bjrny**** |
| Weight |
integer |
后端服务器组的权重。 |
1 |
| Port |
integer |
负载均衡实例对外提供服务的端口号。 |
22 |
| LaunchTemplateOverrides |
array<object> |
扩展启动模板的实例规格信息。 |
|
|
object |
扩展启动模板的实例规格信息。 |
||
| WeightedCapacity |
integer |
指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。 |
4 |
| InstanceType |
string |
指定的实例规格,会覆盖启动模板中的实例规格。 |
ecs.c5.xlarge |
| SpotPriceLimit |
number |
本参数用于指定实例启动模板覆盖规格(即 说明
仅当 |
0.025 |
| AlbServerGroups |
array<object> |
ALB 服务器组的相关信息集合。 |
|
|
object |
ALB 服务器组的相关信息集合。 |
||
| AlbServerGroupId |
string |
ALB 服务器组的 ID。 |
sgp-ddwb0y0g6y9bjm**** |
| Weight |
integer |
弹性伸缩将 ECS 实例添加到 ALB 服务器组后,ECS 实例作为后端服务器的权重。 |
100 |
| Port |
integer |
弹性伸缩将 ECS 实例添加到 ALB 服务器组后,ECS 实例使用的端口号。 |
80 |
| ServerGroups |
array<object> |
负载均衡服务器组的相关信息集合。 说明
您可以通过此参数获取伸缩组关联的 ALB 类型服务组、NLB 类型服务器组和 GWLB 类型服务组的相关信息集合。 |
|
|
object |
负载均衡服务器组的相关信息集合。 |
||
| ServerGroupId |
string |
服务器组 ID。 |
sgp-i9ouakeaerr***** |
| Type |
string |
服务器组类型。可能值:
|
ALB |
| Weight |
integer |
弹性伸缩将 ECS 实例添加到服务器组后,ECS 实例作为后端服务器的权重。 |
100 |
| Port |
integer |
弹性伸缩将 ECS 实例添加到服务器组后,ECS 实例使用的端口号。 |
80 |
| RemovalPolicies |
array |
ECS 实例移出伸缩组的策略的集合。可能值:
|
|
|
string |
ECS 实例移出伸缩组的策略的集合。可能值:
|
OldestScalingConfiguration |
|
| DBInstanceIds |
array |
伸缩组关联 RDS 实例的 ID。 |
|
|
string |
伸缩组关联 RDS 实例的 ID。 |
rm-bp15556qzebg1**** |
|
| LoadBalancerIds |
array |
伸缩组关联的负载均衡实例的 ID 列表。 |
|
|
string |
伸缩组关联的负载均衡实例的 ID 列表。 |
lb-bp19byhscefk3x0li**** |
|
| VSwitchIds |
array |
伸缩组关联虚拟交换机的 ID 集合。如果您使用了 VSwitchIds 参数,VSwitchId 参数将被忽略。 |
|
|
string |
伸缩组关联虚拟交换机的 ID 集合。如果您使用了 VSwitchIds 参数,VSwitchId 参数将被忽略。 |
vsw-bp1whw2u46cn8zubm**** |
|
| SuspendedProcesses |
array |
暂停中的流程,如果没有,则返回值为空。可能值:
|
|
|
string |
暂停中的流程,如果没有,则返回值为空。可能值:
|
ScaleIn |
|
| SystemSuspended |
boolean |
弹性伸缩是否停止执行伸缩组内的伸缩活动。可能值:
|
true |
| IsElasticStrengthInAlarm |
boolean |
说明
该参数未开放使用。 |
false |
| MonitorGroupId |
string |
伸缩组关联的云监控应用分组 ID。 |
1497**** |
| AzBalance |
boolean |
伸缩组的容量是否在多个可用区间均衡分布(仅当
|
false |
| AllocationStrategy |
string |
容量分配策略,决定了伸缩组如何选择可用的实例规格类型满足容量。容量分布策略同时对按量和抢占式容量生效(仅当
|
priority |
| SpotAllocationStrategy |
string |
抢占式容量分布策略。您可以通过该参数单独指定抢占式容量的分布策略(仅当
默认值:priority。 |
lowestPrice |
| MaxInstanceLifetime |
integer |
实例在伸缩组中存活的最大时间。单位为秒。 取值范围:0 或 默认值:null。 说明
ECI 类型的伸缩组或停机不收费的伸缩组不支持设置该参数。 |
null |
| CustomPolicyARN |
string |
自定义缩容策略 Function 函数 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(原 SLB)实例的 ID。 |
lb-2zep8alpq5zq1a2xwyxxx |
| Weight |
integer |
弹性伸缩将 ECS 实例添加到 SLB 服务器组后,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 |
伸缩组的健康检查方式。可能值:
|
ECS |
|
| DBInstances |
array<object> |
伸缩组关联的数据库列表。 |
|
|
object |
伸缩组关联的数据库配置信息。 |
||
| DBInstanceId |
string |
数据库实例 ID。 |
rm-m5eqju85s45mu0*** |
| Type |
string |
数据库类型。可能值:
|
RDS |
| SecurityGroupIds |
array |
伸缩组向数据库添加的安全组白名单列表。 |
|
|
string |
伸缩组向数据库添加的安全组白名单。 当 DetachDBInstances 接口中的 |
sg-uf65zt66cf2a0q47*** |
|
| SpotCapacity |
integer |
伸缩组中抢占式实例的数量。 |
0 |
| StopInstanceTimeout |
integer |
缩容流程中等待 ECS 实例停机成功的超时时间,单位为秒。 |
60 |
| CapacityOptions |
object |
容量选项。 |
|
| OnDemandBaseCapacity |
integer |
已有伸缩组内所需要的按量实例数的最小值,当伸缩组内按量实例个数少于该值时,系统将优先创建按量实例。可能值:0~1000。 |
0 |
| OnDemandPercentageAboveBaseCapacity |
integer |
伸缩组满足最小按量实例数 |
0 |
| CompensateWithOnDemand |
boolean |
当
|
true |
| SpotAutoReplaceOnDemand |
boolean |
当开启
|
false |
| PriceComparisonMode |
string |
伸缩组成本优化策略的比价模式。可能值:
|
PricePerUnit |
| BalanceMode |
string |
可用区均衡模式,仅当开启可用区均衡模式时生效。可能值:
|
BalancedBestEffort |
| AutoRebalance |
boolean |
是否开启伸缩组自动均衡,仅当可用区均衡伸缩组开启了 BalancedOnly 才生效。可能值:
|
false |
示例
正常返回示例
JSON格式
{
"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
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。