接口功能介绍
调用此接口可查询告警模板列表。
接口约束
无。
URI
GET /v4/monitor/query-alarm-templates
请求参数
Query参数
| 参数 |
参数类型 |
是否必填 |
示例 |
说明 |
下级对象 |
| showMode |
String |
否 |
ecs |
本参数表示展示出来的服务。默认返回所有服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 |
|
| templateType |
String |
否 |
all |
本参数表示模板类型。默认all。取值范围：system：系统默认。custom：自定义。all：所有。根据以上范围取值。 |
|
| pageNo |
Integer |
否 |
1 |
页码，默认为1 |
|
| page |
Integer |
否 |
1 |
页码，默认为1，建议使用pageNo，该参数后续会下线 |
|
| pageSize |
Integer |
否 |
2 |
页大小，默认为20 |
|
响应参数
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
| statusCode |
Integer |
返回状态码（800为成功，900为失败），默认值：800 |
800 |
|
| errorCode |
String |
失败时的错误代码，参见公共错误码说明 |
|
|
| message |
String |
失败时的错误描述，一般为英文描述 |
Success |
|
| msgDesc |
String |
失败时的错误描述，一般为中文描述 |
成功 |
|
| returnObj |
Object |
返回参数 |
|
returnObj |
表returnObj
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
| templateList |
Array of Objects |
告警模板列表 |
|
template |
| totalCount |
Integer |
总记录数 |
2 |
|
| totalPage |
Integer |
总页数 |
1 |
|
| currentCount |
Integer |
当前页记录数 |
14 |
|
| page |
Integer |
页码，建议参考请求参数pageNo，该参数后续会下线 |
1 |
|
| pageSize |
Integer |
页大小，建议参考请求参数pageSize，该参数后续会下线 |
10 |
|
表template
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
| templateID |
String |
告警模板ID |
315c7f8c-3e43-11ed-8ef2-005056898fe0 |
|
| lastUpdate |
String |
最近更新时间 |
2022-09-27T09:03:03Z |
|
| name |
String |
告警模板名称 |
bzmcV |
|
| service |
String |
服务 |
ecs |
|
| dimension |
String |
维度 |
ecs |
|
| desc |
String |
告警模板描述 |
test |
|
| rules |
Array of Objects |
告警规则 |
|
rule |
表rule
| 参数 |
参数类型 |
说明 |
示例 |
下级对象 |
| for |
Integer |
持续时间，当规则执行结果持续多久符合条件时报警（防抖） |
120 |
|
| metric |
String |
监控指标 |
cpu_util |
|
| fun |
String |
算法 |
min |
|
| operator |
String |
比较符 |
le |
|
| value |
String |
告警阈值 |
80 |
|
| period |
String |
算法统计周期 |
5m |
|
| level |
Integer |
报警级别 |
1 |
|
请求示例
GET /v4/monitor/query-alarm-templates?showMode=evs&page=1&pageSize=5
响应示例
{
"statusCode":800,
"returnObj":{
"templateList":[
{
"templateID":"e10c380e-5406-11ed-8268-005056897257",
"lastUpdate":"2022-10-25T01:46:44Z",
"name":"template2",
"service":"evs",
"dimension":"disk",
"desc":"test",
"rules":[
{
"for":120,
"metric":"disk_util",
"fun":"avg",
"operator":"eq",
"value":"100",
"period":"5m",
"level":3
}
]
},
{
"templateID":"03c07784-5407-11ed-8268-005056897257",
"lastUpdate":"2022-10-25T01:47:42Z",
"name":"template3",
"service":"evs",
"dimension":"disk",
"desc":"test",
"rules":[
{
"for":120,
"metric":"disk_util",
"fun":"avg",
"operator":"eq",
"value":"100",
"period":"5m",
"level":3
}
]
}
],
"totalCount":2,
"totalPage":1,
"currentCount":2,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
错误码
