CreateAlarm_弹性伸缩_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 如果您创建自定义监控类型的报警任务(MetricType=custom),您需要先将自定义监控项指标上报到云监控。具体操作,请参见自定义监控报警任务
  • 创建报警任务时,您需要指定监控项(MetricName),并配合维度信息(Dimensions.DimensionKey 和 Dimensions.DimensionValue),来确定伸缩组中该监控项数据的聚合范围。例如,指定 user_id 和 scaling_group 来确定聚合该用户、该伸缩组下所有 ECS 实例或 ECI 实例的监控项数据。
    • 自定义监控报警任务(MetricType=custom)的监控项取决于您自有的监控指标。
    • 系统监控报警任务(MetricType=system)支持的监控项的更多信息,请参见系统监控报警任务
说明 维度信息中,user_id 和 scaling_group 由系统自动填充,device、state 需要您手动指定。更多信息,请参见参数Dimensions.DimensionKeyDimensions.DimensionValue

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ess:CreateAlarm
Create
ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

字段名称字段详情
RegionIdstring

伸缩组所属的地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
Namestring

报警任务的名称。

示例值:TestAlarmTask
Descriptionstring

报警任务的描述。

示例值:Test alarm task.
ScalingGroupIdstring

报警任务关联的伸缩组的 ID。

示例值:asg-bp18p2yfxow2dloq****参考取值来源:
    ApplyScalingGroup
    CreateScalingGroup
    DescribeScalingGroups
    AttachServerGroups
    DetachServerGroups
MetricNamestring

监控项名称。取值范围与报警任务的监控类型有关:展开详情

示例值:CpuUtilization
MetricTypestring

监控项类型。取值范围:展开详情

示例值:system
Periodinteger<int32>

统计监控项数据的周期,单位:秒。取值范围:展开详情

示例值:300
Statisticsstring

统计监控项数据的方法。取值范围:展开详情

示例值:Average
Thresholdnumber<float>

监控指标的阈值,满足阈值表达式达到指定次数即触发执行伸缩规则。

示例值:80.0
ComparisonOperatorstring

监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。取值范围:展开详情

示例值:>=
EvaluationCountinteger<int32>

触发执行伸缩规则需要满足阈值表达式的次数,例如,CPU 使用率平均值 3 次的统计结果均大于等于 80%。展开详情

示例值:3
GroupIdinteger<int32>

自定义监控项所属云监控应用分组的 ID,仅在监控项类型为 custom 时需要指定该参数。

示例值:4055401
Effectivestring

指定报警任务的生效时间段,默认所有时间都生效。展开详情

示例值:TZ=+00 * * 1-2 * * ?
AlarmActionsarray<string>

报警任务关联伸缩规则的唯一标识符的列表。

子级条数 <= 5
Dimensionsarray<object>

监控项关联的维度信息。

子级条数 <= 5
Expressionsarray<object>

多指标报警规则相关信息。

子级条数 <= 10
ExpressionsLogicOperatorstring

多指标报警条件之间的关系。取值范围:展开详情

示例值:&&

返回参数

字段名称字段详情
AlarmTaskIdstring

报警任务 ID。

示例值:asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

返回示例

变更历史

变更时间变更内容概要操作
2022-09-09
新增OpenAPI,创建一个报警任务

相关示例