调用DescribeScalingRules查询伸缩组下的伸缩规则,并列出伸缩规则的信息。
接口说明
您可以通过指定伸缩组ID来查询该伸缩组下的所有伸缩规则,查询时可以输入伸缩规则ID、伸缩规则名称、伸缩规则唯一标识符、伸缩规则类型等信息进行过滤。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeScalingRules |
系统规定参数。取值:DescribeScalingRules |
RegionId | String | 是 | cn-qingdao |
伸缩规则所属伸缩组的地域ID。 |
PageNumber | Integer | 否 | 1 |
伸缩规则列表的页码,起始值:1。 默认值:1 |
PageSize | Integer | 否 | 50 |
分页查询时设置的每页行数,最大值:50。 默认值:10 |
ScalingGroupId | String | 否 | asg-bp1ffogfdauy0jw0**** |
伸缩组的ID。 |
ScalingRuleType | String | 否 | SimpleScalingRule |
伸缩规则的类型。取值范围:
|
ShowAlarmRules | Boolean | 否 | false |
是否返回伸缩规则关联的云监控报警任务。取值范围:
默认值:false |
ScalingRuleId.N | RepeatList | 否 | asr-bp1dvirgwkoowxk7**** |
ScalingRuleId.N为待查询伸缩规则的ID,N的取值范围:1~10。 |
ScalingRuleName.N | RepeatList | 否 | scalingrule**** |
ScalingRuleName.N为待查询伸缩规则的名称,N的取值范围:1~10。 |
ScalingRuleAri.N | RepeatList | 否 | ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7**** |
ScalingRuleAri.N为待查询伸缩规则的唯一标识符,N的取值范围:1~10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
当前页码。 |
PageSize | Integer | 50 |
每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
ScalingRules | Array of ScalingRule |
伸缩规则信息组成的集合。 |
|
ScalingRule | |||
AdjustmentType | String | QuantityChangeInCapacity |
伸缩规则的调整方式。取值范围:
|
AdjustmentValue | Integer | 1 |
伸缩规则的调整值。 |
Alarms | Array of Alarm |
伸缩规则关联的云监控报警任务。仅在ShowAlarmRules参数为true时返回伸缩规则关联的云监控报警任务,否则返回空列表。 |
|
Alarm | |||
AlarmTaskId | String | asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b**** |
伸缩规则关联的报警任务的ID。 |
AlarmTaskName | String | alarmtask**** |
伸缩规则关联的报警任务的名称。 |
ComparisonOperator | String | >= |
伸缩规则关联的报警任务使用的监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。取值范围:
|
Dimensions | Array of Dimension |
伸缩规则关联的报警任务的维度信息。 |
|
Dimension | |||
DimensionKey | String | scaling_group |
监控项关联的维度信息键值。取值范围:
|
DimensionValue | String | asg-bp18p2yfxow2dloq**** |
监控项关联的维度信息属性值。 |
EvaluationCount | Integer | 3 |
伸缩规则关联的报警任务到达报警状态需要连续满足阈值表达式的次数。 |
MetricName | String | CpuUtilization |
伸缩规则关联的报警任务监控项名称。 |
MetricType | String | system |
伸缩规则关联的报警任务的类型。取值范围:
|
Statistics | String | Average |
伸缩规则关联的报警任务的统计方式。取值范围:
|
Threshold | Float | 50 |
伸缩规则关联的报警任务的报警阈值。 |
Cooldown | Integer | 20 |
伸缩规则的冷却时间,仅适用于简单规则。 取值范围:0~86400,单位:秒。 |
DisableScaleIn | Boolean | true |
是否禁用缩容,仅适用于目标追踪规则。取值范围:
|
EstimatedInstanceWarmup | Integer | 300 |
实例预热时间。 |
InitialMaxSize | Integer | 100 |
伸缩组实例数的上限,和PredictiveValueBehavior结合使用。 |
MaxSize | Integer | 2 |
伸缩组最大实例数。 |
MetricName | String | CpuUtilization |
预定义监控项,适用于目标追踪规则和预测规则。 目标追踪伸缩规则取值范围:
预测规则取值范围:
|
MinAdjustmentMagnitude | Integer | 1 |
伸缩规则最小调整实例数,仅当伸缩规则类型为SimpleScalingRule或StepScalingRule,且AdjustmentType为PercentChangeInCapacity时生效。 |
MinSize | Integer | 1 |
伸缩组最小实例数。 |
PredictiveScalingMode | String | PredictAndScale |
预测规则的模式。取值范围:
|
PredictiveTaskBufferTime | Integer | 30 |
预测规则自动创建的预测任务默认均在整点执行,您可以设置预启动时间提前执行预测任务,预先准备资源。取值范围:0~60,单位:分钟。 |
PredictiveValueBehavior | String | MaxOverridePredictiveValue |
预测规则最大值处理方式。取值范围:
|
PredictiveValueBuffer | Integer | 50 |
PredictiveValueBehavior为PredictiveValueOverrideMaxWithBuffer时生效,预测值会按照该比例增加,当增加后的值大于初始最大值时,会采用增加后的值。取值范围:0~100。 |
ScaleInEvaluationCount | Integer | 15 |
创建目标追踪规则后,会自动创建报警任务。本参数用于指定对应的缩容报警任务触发报警时,所需连续满足阈值条件的次数。 |
ScaleOutEvaluationCount | Integer | 3 |
创建目标追踪规则后,会自动创建报警任务。本参数用于指定对应的扩容报警任务触发报警时,所需连续满足阈值条件的次数。 |
ScalingGroupId | String | asg-bp1ffogfdauy0jw0**** |
伸缩组的ID。 |
ScalingRuleAri | String | ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7**** |
伸缩规则的唯一标识符。 |
ScalingRuleId | String | asr-bp1dvirgwkoowxk7**** |
伸缩规则的ID。 |
ScalingRuleName | String | scalingrule**** |
伸缩规则的名称。 |
ScalingRuleType | String | SimpleScalingRule |
伸缩规则类型。取值范围:
|
StepAdjustments | Array of StepAdjustment |
步进规则的分步步骤。 |
|
StepAdjustment | |||
MetricIntervalLowerBound | Float | 1.0 |
分步步骤的下边界,取值范围:-9.999999E18~9.999999E18。 |
MetricIntervalUpperBound | Float | 5.0 |
分步步骤的上边界,取值范围:-9.999999E18~9.999999E18。 |
ScalingAdjustment | Integer | 1 |
分步步骤对应的实例扩展数量。 |
TargetValue | Float | 0.125 |
目标值。 |
TotalCount | Integer | 1 |
伸缩规则总数。 |
示例
请求示例
https://ess.aliyuncs.com/?Action=DescribeScalingRules
&RegionId=cn-qingdao
&ScalingGroupId=asg-bp1ffogfdauy0jw0****
&PageSize=50
&<公共请求参数>
正常返回示例
XML
格式
<DescribeScalingRulesResponse>
<PageNumber>1</PageNumber>
<PageSize>50</PageSize>
<ScalingRules>
<ScalingRule>
<AdjustmentType>QuantityChangeInCapacity</AdjustmentType>
<AdjustmentValue>1</AdjustmentValue>
<Cooldown>20</Cooldown>
<ScalingGroupId>asg-bp1ffogfdauy0jw0****</ScalingGroupId>
<ScalingRuleAri>ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****</ScalingRuleAri>
<ScalingRuleId>asr-bp1dvirgwkoowxk7****</ScalingRuleId>
<ScalingRuleName>scalingrule****</ScalingRuleName>
</ScalingRule>
</ScalingRules>
<TotalCount>1</TotalCount>
<RequestId>3306A40D-3412-4101-9F19-5F81E3055DAD</RequestId>
</DescribeScalingRulesResponse>
JSON
格式
{
"RequestId": "B583BFEF-A779-427A-9B74-262DDD249702",
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10,
"ScalingRules": {
"ScalingRule": [
{
"ScalingRuleId": "asr-bp1dvirgwkoowxk7****",
"ScalingRuleAri": "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****",
"Cooldown": 500,
"ScalingGroupId": "asg-bp1ffogfdauy0jw0****",
"AdjustmentType": "TotalCapacity",
"ScalingRuleName": "scalingrule****",
"AdjustmentValue": 5
}
]
}
}
错误码
访问错误中心查看更多错误码。