接口功能介绍
后门检测-白名单根据列表查询接口。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
POST /v1/backdoor/queryWhiteList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentNum | 是 | Integer | 当前页码 | 1 | |
| pageSize | 是 | Integer | 每页大小 | 10 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| custName | 否 | String | 主机名称，可传控制字符串，不能传null | ||
| privateIp | 否 | String | 私网ip |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000：成功 CTCSSCN_000001：失败 CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN_000004：鉴权错误 CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ctyunUserId | String | 用户id | ||
| alertName | String | 告警类型名称 | ||
| alertType | String | 告警类型 | ||
| description | String | 描述 | ||
| agentGuidList | Array of Strings | 主机列表id | ||
| hostCount | String | 同一用户，相同告警类型统计 | ||
| remark | String | 备注 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"custName": "1012121112","privateIp": "1.1.1.1","publicIp": "1.1.1.2","agentGuids": ["1012121112"]}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"total":100,"pageNum":1,"pageSiz":10,"list": [{"ctyunUserId": "1012121112","description": "描述","agentGuids": ["1012121112"],"alertName": "21","alertType": "1","remark": "1012121112","hostCount": 1}]}}
状态码
请参考 状态码
错误码
请参考 错误码
