告警聯系人組：更新
更新時間 2024-09-25 16:20:58
最近更新時間: 2024-09-25 16:20:58
分享文章
告警聯系人/組
告警聯系人組：更新
接口功能介紹
調用此接口可修改告警聯系組基本信息， 支持全量字段修改。
接口約束
告警聯系人組存在，告警聯系人組名稱不可重復，可包含字母、中文、數字，2-50個字符。
URI
POST /v4/monitor/update-contact-group
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| contactGroupID | 是 | String | 組ID | fe7f0cdc-4692-5516-8d3a-b06355482090 | |
| name | 是 | String | 告警聯系組新名稱 | moCEN | |
| desc | 否 | String | 告警聯系組新描述 | test | |
| contactIDList | 否 | Array of Strings | 告警聯系人ID列表 | ['a6fb570f-2299-5bde-989c-df0819c687d0'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactGroupID | String | 告警聯系人組ID | bbfb781d-2299-5bde-989c-df0819c687d0 |
請求示例
請求url
/v4/monitor/update-contact-group
請求頭header
無
請求體body
{
"contactGroupID": "fe7f0cdc-4692-5516-8d3a-b06355482090",
"name": "testname"
}
響應示例
{
"statusCode": 800,
"returnObj": {
"contactGroupID": "fe7f0cdc-4692-5516-8d3a-b06355482090"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.ContactGroup.ContactGroupNotExist | 告警聯系組不存在 |
| Monitor.ContactGroup.NameAlreadyExist | 告警聯系組名稱已存在 |
| 其他 | 參見公共錯誤碼說明 |
