告警模板
告警模板：更新
接口功能介绍
调用此接口可更新告警模板。
接口约束
告警模板内容不能为空。
URI
POST /v4/monitor/update-alarm-template
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateID | 是 | String | 告警模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 | |
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 告警模板名称 | xsZSu | |
| desc | 否 | String | 告警模板描述 | test | |
| service | 是 | String | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | ecs | |
| dimension | 是 | String | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| conditions | 否 | Array of Objects | 告警规则 | condition |
表 condition
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| evaluationCount | 否 | Integer | 持续次数，当规则执行结果持续多久符合条件时报警（防抖），默认值：2 | 2 | |
| metric | 否 | String | 监控指标, 说明：当有condition参数时，metric是必填项 | cpu_util | |
| fun | 否 | String | 本参数表示采用算法。默认值：min。取值范围：last：原始值。avg：平均值。max：最大值。min：最小值。sum：总和。根据以上范围取值。 | min | |
| operator | 否 | String | 本参数表示比较符。默认值：le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。ne：不等于。rg：环比上升。cf：环比下降。rc：环比变化。根据以上范围取值。 | le | |
| value | 否 | String | 告警阈值，整数型或小数点型字符串， 默认值：80。 如果是小数点型字符串，小数点位数不能超过2位。 | 80 | |
| period | 否 | String | 本参数表示算法统计周期。默认值：5m。参数fun为last时不可传。参数fun为avg、max、min、sum均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | 5m | |
| unit | 否 | String | 本参数表示单位. 默认值：空字符。 | KB/s |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| templateID | String | 告警模板ID | 312b56b4-3e43-11ed-8ef2-005056898fe0 |
请求示例
请求url
/v4/monitor/update-alram-template
请求头header
无
请求体body
{
"templateID":"312b56b4-3e43-11ed-8ef2-005056898fe0",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name":"xsZSu",
"service":"ecs",
"dimension":"ecs",
"desc":"test",
"conditions":[
{
"metric":"cpu_util",
"fun":"avg",
"value":"100",
"operator":"eq",
"evaluationCount":2,
"period":"5m"
},
{
"metric":"cpu_util",
"fun":"avg",
"value":"60",
"operator":"eq",
"evaluationCount":2,
"period":"5m"
}
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlarmTemplate.TemplateIDNotFound | 告警模板ID不存在 |
| Monitor.AlarmTemplate.NameAlreadyExist | 告警模板名称已存在 |
| Monitor.AlarmTemplate.MetricInvalid | 告警模板监控项错误 |
| 其他 | 参见公共错误码说明 |
