告警通知模板：查詢變量
更新時間 2024-09-25 16:20:55
最近更新時間: 2024-09-25 16:20:55
分享文章
通知模板
通知模板：查詢變量
接口功能介紹
調用此接口可查詢信息配置的基本信息和告警對象。
接口約束
參見請求參數說明。
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 | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
