调用PutCustomMetricRule接口创建自定义监控报警规则。
接口说明
调用本接口前,请先调用 PutCustomMetric 接口上报自定义监控数据,详情请参见 PutCustomMetric 。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:PutCustomMetricRule | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 否 | 自定义监控数据所属应用分组 ID。 说明
0 表示上报的自定义监控数据不属于任何一个应用分组。
| 7378**** |
| RuleId | string | 是 | 报警规则 ID。 说明
如果报警规则 ID 已存在,则表示修改报警规则;如果报警规则 ID 不存在,则表示创建报警规则。
| MyRuleId1 |
| RuleName | string | 否 | 报警规则名称。 | CpuUsage |
| MetricName | string | 是 | 监控项名称。 说明
获取方法请参见 DescribeCustomMetricList 。
| cpu_total |
| Resources | string | 是 | 报警规则作用的自定义监控数据。由自定义监控数据所属应用分组 ID 和监控项所属维度组成。 | [{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}] |
| ContactGroups | string | 是 | 报警联系人组。多个联系人组之间用英文逗号(,)分隔。 | ECS_Group |
| Webhook | string | 否 | 报警发生回调时指定的 URL 地址,向 URL 发送 POST 请求。 | https://www.aliyun.com |
| EffectiveInterval | string | 否 | 报警规则生效的时间范围。取值范围:00:00-23:59。 | 00:00-23:59 |
| SilenceTime | integer | 否 | 通道沉默周期。单位:秒,默认值:86400(1 天)。 说明
当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。
| 86400 |
| Period | string | 否 | 自定义监控数据的聚合周期。单位:秒。取值为 60 或 60 的整数倍。默认为自定义监控数据的原始上报周期。 | 300 |
| EmailSubject | string | 否 | 报警邮件主题。 | ECS实例 |
| Threshold | string | 是 | 报警阈值。 | 90 |
| Level | string | 是 | 报警级别。取值:
| CRITICAL |
| EvaluationCount | integer | 是 | 报警重试次数。 | 3 |
| Statistics | string | 是 | 报警统计方法。 | Average |
| ComparisonOperator | string | 是 | 阈值比较符号。取值:
| >= |
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "ComparisonOperator is mandatory for this action.",
"RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9432",
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 403 | %s | %s |
| 500 | InternalError | The request processing has failed due to some unknown error. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史
