接口功能介绍
防护配置可用服务器列表查询接口
接口约束
此功能为收费功能。确认已经购买网页防篡改配额，并且开启防篡改扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护
URI
POST /v1/host/queryFilterHostList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 列表当前页 | 1 | |
| pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| agentStateCode | 否 | Integer | 服务器状态码： 12-在线 13-离线 14-从未连接 15-未激活 |
12 | |
| fangHuPeIe | 否 | String | 防护配额 0-未开启防护 1-开启防护 |
0,1 | |
| queryParameter | 否 | String | 服务器名称、服务器IP，模糊查询 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000：成功 CTCSSCN_000001：失败 CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN_000004：鉴权错误 CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | pageInfo |
表 pageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页记录数 | 10 | |
| pages | Integer | 总页数 | 2 | |
| total | Integer | 总记录数 | 20 | |
| isFirstPage | Boolean | 是否为首页 | false | |
| isLastPage | Boolean | 是否为末页 | false | |
| list | Object | 列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| custName | String | 服务器名称 | CentOS76-az1-2 | |
| agentGuid | String | 服务器id | F5283205-CB2C-45E6-8629-9D5DB63D3AC3 | |
| agentIp | String | 服务器ip | 172.18.208.172 | |
| osType | String | 服务器系统类型 | linux |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"agentStateCode":"12,13,14","fangHuPeIe":"0,1","protectLevel":"1,2","queryParameter":"192.168.0.17"}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"total": 2,"list": [{"custName": "CentOS76-az1-2","agentGuid": "F5283205-CB2C-45E6-8629-9D5DB63D3AC3","agentIp": "172.18.208.172","osType": "linux",},{"custName": "172.18.103.64","agentGuid": "34563142-91F7-DF4D-7E75-A174E4CDB783","agentIp": "172.18.103.64","osType": "centos",}],"pageNum": 1,"pageSize": 10,"size": 2,"startRow": 1,"endRow": 2,"pages": 1,"prePage": 0,"nextPage": 0,"isFirstPage": true,"isLastPage": true,"hasPreviousPage": false,"hasNextPage": false,"navigatePages": 8,"navigatepageNums": [1],"navigateFirstPage": 1,"navigateLastPage": 1}}
状态码
请参考 状态码
错误码
请参考 错误码
