接口功能介绍
反弹shell产生告警事件后,用户可以对已经产生的告警事件进行统计查询,查看反弹shell告警事件数量、服务器数量等。
接口约束
此功能为收费功能。确认已经购买服务器配额,并且开启服务器防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护。
URI
POST /v1/reverseShell/event/statistics/query
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
queryParam | 否 | Object | 查询参数 | 查询参数 | object |
表 object
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
timeType | 否 | String | 时间类型 LAST_ONE_WEEK最近1周 LAST_ONE_MONTH最近一月 LAST_THREE_MONTH最近三月 LAST_WEEK最近几周结合timeRange使用 LAST_MONTH最近几月结合timeRange使用 |
LAST_ONE_WEEK | |
timeRange | 否 | String | 时间范围,timeType为/LAST_WEEK、LAST_MONTH 必填 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码 CTCSSCN_000000:成功 CTCSSCN_000001:失败 CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 CTCSSCN_000004:鉴权错误 CTCSSCN_000005:用户没有付费版配额,功能不可用 |
CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | data |
表 data
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pendingCount | Long | 待处理告警事件总数 | 10 | |
riskCount | Long | 存在风险的服务器总数 | 10 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"alertType": "reverseShell","queryParam": {"timeType": "LAST_ONE_WEEK"}}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"pendingCount": 20,"riskCount": 20}}
状态码
请参考 状态码
错误码
请参考 错误码