接口功能介绍
查询用户各类告警的告警配置，如当告警发生时，是否发送邮件。
接口约束
此功能为免费功能。
URI
GET /v1/setFocus/queryList
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000 :成功; CTCSSCN_000001:失败; CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用; CTCSSCN_000004：鉴权错误; CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | Data |
表 Data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalStatus | Integer | 告警总开关0-关闭 1-打开 | 1 | |
| updateAlerts | Array of Objects | 告警配置 | AlertInfo |
表 AlertInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alertType | Integer | 告警类型 1-网页放篡改 2-异常登录 3-暴力破解 4-Linux漏洞 5-基线检测 6-弱口令检测 7-病毒查杀 8-可疑操作 9-后门检测 10-win漏洞 11-反弹shell |
1 | |
| status | Integer | 告警开关 0-关闭 1-打开 |
0 | |
| noticeType | Integer | 告警通知方式 0-短信 1-邮件 2-站内信 3-mdr |
1 | |
| alertEvent | Integer | 告警事件等级列表 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
无
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"totalStatus": 1,"updateAlerts": [{"alertType": 1,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [1],"extInfo": null},{"alertType": 10,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [0,8,1],"extInfo": null},{"alertType": 11,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [0,8,1,2,3],"extInfo": null},{"alertType": 2,"status": 0,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [4],"extInfo": null},{"alertType": 3,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [5],"extInfo": null},{"alertType": 4,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [0,8,1],"extInfo": null},{"alertType": 5,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [6],"extInfo": null},{"alertType": 6,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [7],"extInfo": null},{"alertType": 7,"status": 1,"totalStatus": 1,"noticeType": [2,1],"alertEvent": [1],"extInfo": null},{"alertType": 8,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [1,2],"extInfo": null},{"alertType": 9,"status": 1,"totalStatus": 1,"noticeType": [1,2],"alertEvent": [1,3,2],"extInfo": null}]}}
状态码
请参考 状态码
错误码
请参考 错误码
