通知模板
通知模板：查询变量
接口功能介绍
调用此接口可查询信息配置的基本信息和告警对象。
接口约束
参见请求参数说明。
URI
GET /v4/monitor/query-notice-template-variable
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| group | 是 | String | 本参数表示分组名称。取值范围：basic：基本信息。entity：告警对象。 根据以上范围取值。 | basic | |
| dimension | 是 | String | 告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，适配中英文 | 成功 | |
| description | String | 失败时的错误描述，适配中英文 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Array of Objects | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | lable名称 | basic.idc | |
| description | String | lable描述 | 资源池名称 |
请求示例
请求url
/v4/monitor/query-notice-template-variable?group=basic&dimension=ecs
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": [
{
"name": "basic.idc",
"description": "资源池名称"
},
{
"name": "basic.ctime",
"description": "首次发生时间"
},
{
"name": "basic.mtime",
"description": "当前告警时间"
},
{
"name": "basic.rulename",
"description": "规则名称"
},
{
"name": "basic.ruledesc",
"description": "规则描述"
}
],
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
