找不到 API ? 点击 反馈吧
- 伸缩组
- 伸缩配置
- 伸缩规则
- 触发任务
- 定时任务
- 报警任务
- 实例刷新
- 生命周期挂钩
- 事件通知
- 健康诊断
- 实例
- 地域
- 标签
- 其他
CreateAlarm
针对具有突发性或时间上不易预测的业务,调用CreateAlarm创建一个报警任务,该任务关联云监控指标后,可以动态调整伸缩组内的ECS实例或ECI实例数量,并实时监控实例指标,帮助您更好地管理和维护云资源
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
RegionId伸缩组所属的地域ID
Name报警任务的名称
Description报警任务的描述
ScalingGroupId报警任务关联的伸缩组的ID
MetricName监控项名称
MetricType监控项类型
Period统计监控项数据的周期
Statistics统计监控项数据的方法
Threshold监控指标的阈值
ComparisonOperator监控项统计值与阈值的比较符
EvaluationCount触发执行伸缩规则需要满足阈值表达式的次数
GroupId自定义监控项所属云监控应用分组的ID
Effective指定报警任务的生效时间段
AlarmActions报警任务关联伸缩规则的唯一标识符的列表
Dimensions监控项关联的维度信息
Expressions多指标报警规则相关信息
0多指标报警规则相关信息
MetricName多指标报警规则的监控指标名称
ComparisonOperator多指标报警规则的监控项统计值与阈值的比较符
Period多指标报警规则中统计监控项数据的周期
Statistics多指标报警规则中统计监控项数据的方法
Threshold多指标报警规则中监控指标的阈值
ExpressionsLogicOperator多指标报警条件之间的关系
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
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.DimensionKey
和Dimensions.DimensionValue
。
请求参数
字段名称 | 字段详情 |
---|---|
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,创建一个报警任务 |