告警聯系人：創建
更新時間 2024-09-25 16:20:57
最近更新時間: 2024-09-25 16:20:57
分享文章
告警聯系人/組
告警聯系人：創建
接口功能介紹
調用此接口可創建告警聯系人，用于告警通知。
接口約束
告警聯系人名稱不可重復，可包含字母、中文、數字，2-50個字符。
URI
POST /v4/monitor/create-contact
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 用戶名 | moCEN | |
| phone | 否 | String | 手機號， 手機號和郵箱二選一必填，手機號填了，郵箱可不填，反之一樣，二者不能全為空。 | 13309310049 | |
| 否 | String | 郵箱， 手機號和郵箱二選一必填，郵箱填了，手機號可不填，反之一樣，二者不能全為空。 | 123323@qq.com |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactID | String | 告警聯系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 |
請求示例
請求url
/v4/monitor/create-contact
請求頭header
無
請求體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 | 告警聯系人名稱已存在 |
| 其他 | 參見公共錯誤碼說明 |
