告警聯系人：創建
更(geng)新時(shi)間(jian) 2023-07-19 17:40:43
最(zui)近更(geng)新時間: 2023-07-19 17:40:43
分享文章
接口功能介紹
調用此接口可創(chuang)建告警聯系人(ren)，用于(yu)告警通知。
接口約束
告(gao)警聯(lian)系人名稱不可(ke)重(zhong)復，可(ke)包含字(zi)母、中文、數字(zi)，2-30個字(zi)符(fu)。
URI
POST /v4/monitor/create-contact
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| name | String | 是 | moCEN | 用戶名 | |
| phone | String | 否 | 13309310049 | 手機號 | |
| String | 否 | 123323@qq.com | 郵箱 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactID | String | 告警聯系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 |
請求示例
POST /v4/monitor/create-contact
請求體body
{
"name": "moCEN",
"phone": "13309310049",
"email": "123323@qq.com"
}
響應示例
{
"statusCode":800,
"returnObj":{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Contact.NameAlreadyExist | 告警聯系人名稱已存在 |
| 其他 | 參見公共錯誤碼說明 |
