接口功能介绍
调用此接口可查看告警模板的配置详情。
接口约束
告警模板ID不能为空，且应为已创建的模板的ID。
URI
GET /v4/monitor/describe-alarm-template
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| templateID | String | 是 | 315c7f8c-3e43-11ed-8ef2-005056898fe0 | 告警模板ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/describe-alarm-template?templateID=315c7f8c-3e43-11ed-8ef2-005056898fe0
响应示例
{
"statusCode":800,
"returnObj":{
"templateID":"315c7f8c-3e43-11ed-8ef2-005056898fe0",
"lastUpdate":"2022-09-27T09:03:03Z",
"name":"bzmcV",
"service":"ecs",
"dimension":"ecs",
"desc":"test",
"rules":[
{
"for":300,
"metric":"cpu_util",
"fun":"min",
"operator":"le",
"value":100,
"period":"5m",
"level":1
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlarmTemplate.TemplateIDNotFound | 告警模板ID不存在 |
| 其他 | 参见公共错误码说明 |
