接口功能介绍
调用此接口可创建告警模板。
接口约束
告警模板内容不能为空。
URI
POST /v4/monitor/create-alarm-template
请求参数
请求体body参数
| 参数 |
参数类型 |
是否必填 |
示例 |
说明 |
下级对象 |
| content |
Object |
是 |
|
告警模板内容 |
content |
表content
| 参数 |
参数类型 |
是否必填 |
示例 |
说明 |
下级对象 |
| name |
String |
是 |
xsZSu |
告警模板名称 |
|
| ser |
String |
是 |
ecs |
本参数表示告警服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 |
|
| dim |
String |
是 |
ecs |
本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 |
|
| desc |
String |
否 |
test |
告警模板描述 |
|
| rules |
Array of Objects |
是 |
|
告警规则 |
rule |
表rule
| 参数 |
参数类型 |
是否必填 |
示例 |
说明 |
下级对象 |
| for |
Integer |
否 |
120 |
持续时间，当规则执行结果持续多久符合条件时报警（防抖），默认120s |
|
| metric |
String |
否 |
cpu_util |
监控指标，默认为cpu_util |
|
| fun |
String |
否 |
min |
本参数表示采用算法。默认值min。取值范围：last：原始值。avg：平均值。max：最大值。min：最小值。根据以上范围取值。 |
|
| operator |
String |
否 |
le |
本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 |
|
| value |
String |
否 |
80 |
告警阈值，整数、小数、百分数格式字符串，默认为80 |
|
| period |
String |
否 |
5m |
本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 |
|
| level |
Integer |
否 |
1 |
本参数表示报警级别。默认值1。取值范围：1：灾难告警。2：严重告警。3：一般告警。4：警告告警。根据以上范围取值。 |
|
响应参数
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
| statusCode |
Integer |
返回状态码（800为成功，900为失败），默认值：800 |
800 |
|
| errorCode |
String |
失败时的错误代码，参见公共错误码说明 |
|
|
| message |
String |
失败时的错误描述，一般为英文描述 |
Success |
|
| msgDesc |
String |
失败时的错误描述，一般为中文描述 |
成功 |
|
| returnObj |
Object |
返回参数，参考returnObj对象结构 |
|
returnObj |
表returnObj
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
| templateID |
String |
告警模板ID |
312b56b4-3e43-11ed-8ef2-005056898fe0 |
|
请求示例
POST /v4/monitor/create-alram-template
请求体body
{
"content":{
"name":"xsZSu",
"ser":"ecs",
"dim":"ecs",
"desc":"test",
"rules":[
{
"metric":"cpu_util",
"fun":"avg",
"value":"100",
"operator":"eq",
"for":120,
"period":"5m",
"level":3
},
{
"metric":"cpu_util",
"fun":"avg",
"value":"70",
"operator":"eq",
"for":120,
"period":"5m",
"level":2
}
]
}
}
响应示例
{
"statusCode":800,
"returnObj":{
"templateID":"312b56b4-3e43-11ed-8ef2-005056898fe0"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
错误码
| errorCode |
描述 |
| Monitor.AlarmTemplate.NameAlreadyExist |
告警模板名称已存在 |
| 其他 |
参见公共错误码说明 |
