外部告警
外部告警：获取告警联系人组token
接口功能介绍
调用此接口可获取告警联系人组token。
接口约束
无。
URI
GET /v4/monitor/get-token
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| contactGroupID | 是 | String | 告警联系人组ID | cf21ea17-e31d-5f47-bf10-6c489a86f67d |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| token | String | token | 1411668ec8c13f57472576d5d1603226 |
请求示例
请求url
/v4/monitor/get-token?contactGroupID=cf21ea17-e31d-5f47-bf10-6c489a86f67d
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"returnObj":{
"token":"1411668ec8c13f57472576d5d1603226"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.ContactGroup.ContactGroupNotExist | 告警联系组不存在 |
| 其他 | 参见公共错误码说明 |
