告警聯系人:查看詳情
更新時間 2023-07-19 19:00:28
最近更新時間: 2023-07-19 19:00:28
分享文章
接口功能介紹
調用此(ci)接口(kou)可查看告警聯(lian)系人的配置詳情。
接口約束
告(gao)警(jing)聯系人ID存(cun)在(zai)。
URI
GET /v4/monitor/describe-contact
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| contactID | String | 是 | a6fb570f-2299-5bde-989c-df0819c687d0 | 告警聯系人ID |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼,參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述,一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表(biao)returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactID | String | 告警聯系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| name | String | 用戶名 | gxlupdate | |
| phone | String | 手機號 | 18919128910 | |
| String | 郵箱 | 864307365@qq.com | ||
| contactGroupList | Array of Objects | 所屬組信息 | contactGroup | |
| lastUpdate | String | 最近更新時間 | 2022-09-29T09:51:33Z |
表contactGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactGroupID | String | 聯系人組ID | b6fb5df3-gasd-5bde-989c-df0819c687d0 | |
| name | String | 聯系人組名稱 | testgroup |
請求示例
GET /v4/monitor/describe-contact?contactID=a6fb570f-2299-5bde-989c-df0819c687d0
響應示例
{
"statusCode":800,
"returnObj":{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0",
"lastUpdate":"2022-09-29T09:51:33Z",
"name":"gxlupdate",
"phone":"18919128910",
"email":"864307365@qq.com",
"contactGroupList":[]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |