查询网页防篡改服务器列表
更新时间 2025-12-25 11:51:14
最近更新时间: 2025-12-25 11:51:14
接口功能介绍
防护配置可用服务器列表查询接口
接口约束
此功能为收费功能。确认已经购买网页防篡改配额,并且开启防篡改扫描配置。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护
URI
POST /v1/host/queryFilterHostList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 页码 | ||
| pageSize | 是 | Integer | 每页数量 |
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| agentStateCode | 否 | String | agent状态 | ||
| 12-在线 13-离线 | 12 | ||||
| custName | 否 | String | 主机名称 | test-host-name | |
| type | 否 | String | 服务器类型:vm 虚机;pm 物理机 | vm | |
| agentIp | 否 | String | 服务器ip | 192.168.1.1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000:成功 | ||||
| CTCSSCN_000001:失败 | ||||
| CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004:鉴权错误 | ||||
| CTCSSCN_000005:用户没有付费版配额,功能不可用 | CTCSSCN_000000 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | 211111111111111111111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总数 | 100 | |
| list | Array of Objects | 结果集 | list | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | ||
| 每页数量 | ||||
| 每页的数量 | 10 | |||
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| hostname | String | 实例名称 | test-display-name | |
| custName | String | 主机名称 | test-server-name | |
| agentGuid | String | agentGuid | 111-111-111-111 | |
| agentIp | String | 私有ip | 192.168.1.1 | |
| osType | String | 操作系统 Linux/Windows | Linux | |
| status | Integer | 服务器运行状态 5:运行中 其他为已关机 | 5 | |
| vpcName | String | vpc名称 | test-vpc-name | |
| vpcId | String | vpcId | test-vpc-id |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"agentStateCode": "12", "custName": "test-host-name", "type": "vm", "agentIp": "192.168.1.1"}
响应示例
{"message": "success", "traceId": "211111111111111111111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"total": 100, "list": [{"hostname": "test-display-name", "custName": "test-server-name", "agentGuid": "111-111-111-111", "agentIp": "192.168.1.1", "osType": "Linux", "status": 5, "vpcName": "test-vpc-name", "vpcId": "test-vpc-id"}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码