告警模板
告警模板：查看详情
接口功能介绍
调用此接口可查看告警模板的配置详情。
接口约束
告警模板ID不能为空，且应为已创建的模板的ID。
URI
GET /v4/monitor/describe-alarm-template
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| templateID | 是 | String | 告警模板ID | 315c7f8c-3e43-11ed-8ef2-005056898fe0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| templateID | String | 告警模板ID | 315c7f8c-3e43-11ed-8ef2-005056898fe0 | |
| name | String | 告警模板名称 | bzmcV | |
| service | String | 服务 | ecs | |
| dimension | String | 维度 | ecs | |
| desc | String | 告警模板描述 | test | |
| conditions | Array of Objects | 告警规则 | condition | |
| createTime | Integer | 创建时间，时间戳，精确到毫秒 | 1667459789000 | |
| updateTime | Integer | 最近更新时间, 时间戳，精确到毫秒 | 1667459789000 |
表 condition
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| evaluationCount | Integer | 持续次数，当规则执行结果持续多久符合条件时报警（防抖） | 2 | |
| metric | String | 监控指标 | cpu_util | |
| metricCnName | String | 监控指标中文描述 | cpu使用率 | |
| fun | String | 算法 | min | |
| operator | String | 比较符 | le | |
| value | String | 告警阈值 | 80 | |
| period | String | 算法统计周期 | 5m | |
| unit | String | 单位 | KB/s |
请求示例
请求url
/v4/monitor/describe-alarm-template?templateID=315c7f8c-3e43-11ed-8ef2-005056898fe0®ionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"returnObj":{
"templateID":"8f29cc8c-fa92-5009-816a-6022761f91e6",
"name":"xsZSu",
"service":"ecs",
"dimension":"ecs",
"desc":"test",
"conditions":[
{
"evaluationCount":2,
"metric":"cpu_util",
"metricCnName":"cpu使用率",
"fun":"avg",
"operator":"eq",
"value":"100",
"period":"5m",
"unit":""
},
{
"evaluationCount":2,
"metric":"cpu_util",
"metricCnName":"cpu使用率",
"fun":"avg",
"operator":"eq",
"value":"70",
"period":"5m",
"unit":""
}
],
"createTime":1694916692000,
"updateTime":1694916692000
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlarmTemplate.TemplateIDNotFound | 告警模板ID不存在 |
| 其他 | 参见公共错误码说明 |
