接口功能介绍
展示同步资产的数据。
接口约束
防护状态与agent状态相关，Agent状态：在线；防护状态： 防护中|已关闭； Agent状态：离线|错误；防护状态：已离线；Agent状态：未激活；防护状态：未防护
URI
POST /v1/host/all
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 当前页 | 1 | |
| pageSize | 是 | Integer | 每页条数 | 10 | |
| guardType | 否 | Integer | 防护状态：1：防护中，2：已关闭，3：已离线，4：未防护, 0或者不传代表全部防护状态 | 1 | |
| riskLevel | 否 | Integer | 风险级别：1：安全，2：未知，3：风险，0或者不传代表风险级别 | 1 | |
| paramType | 否 | Integer | 1. 服务器名称；2.服务器ip;5-agentGuid;只需要是正整数即可。 | 1 | |
| param | 否 | String | 具体搜索内容（与paramType同时使用） | test | |
| regionId | 否 | String | 地域ID | 9035c530814611e990660242ac110002 | |
| agentState | 否 | Integer | 1: 在线;2：离线; 3:未激活; 4:错误；后续可扩展状态，故为正整数即可。0或者不传代表全部状态 | 1 | |
| quotaVersion | 否 | Integer | 配额版本 1：基础版；2：企业版 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码CTCSSCN_000000 :成功;CTCSSCN_000001:失败;CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用;CTCSSCN_000004：鉴权错误;CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | map |
表 map
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 记录总数 | 5 | |
| pageSize | Integer | 页大小 | 10 | |
| pageNum | Integer | 当前页 | 1 | |
| pages | Integer | 总页数 | 1 | |
| list | Array of Objects | 服务器列表信息 | serverlist |
表 serverlist
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentIp | String | 私网IP | 1.1.1.1 | |
| hostId | Long | 主机ID | 1111 | |
| publicIp | String | 公网IP | 1.1.1.1 | |
| custName | String | 服务器名称 | cust2016 | |
| osType | String | 操作系统linux/windows | linux | |
| agentGuid | String | agentGuid | aa-bb-cc-dd | |
| type | String | 服务器类型 | ||
| agentStateCode | String | agent状态,在线/离线/未激活/错误 | 在线 | |
| guardStatus | String | 防护状态，防护中/已关闭/已离线/未防护/未激活 | 防护中 | |
| regionName | String | 地域名称 | ||
| sshRisk | Integer | 入侵检测风险数 | 1 | |
| vulRisk | Integer | 漏洞扫描风险数 | 1 | |
| wpRisk | Integer | 网页防篡改风险数 | 1 | |
| scaRisk | Integer | 安全基线风险数 | 1 | |
| virusRisk | Integer | 病毒查杀风险数 | 1 | |
| riskStatus | String | 风险状态 风险/安全/未知 | 风险 | |
| quotaVersion | Integer | 配额版本 1：基础版；2：企业版 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"currentPage": 1,"pageSize": 2}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"total": 10511,"list": [{"agentIp": "10.104.1.50","publicIp": "","custName": "ecm-waf-lvs-0001","hostName": null,"osType": "linux","agentStateCode": "在线","agentGuid": "00792349-CE6B-42EB-A838-20A00DD86F07","hostId": 131530,"type": "vm","guardStatus": "防护中","regionName": "北京5","sshRisk": 0,"vulRisk": 0,"wpRisk": 0,"scaRisk": 0,"virusRisk": 0,"riskStatus": "安全","quotaVersion": 2},{"agentIp": "10.104.1.226","publicIp": "","custName": "ecm-waf-lvs","hostName": null,"osType": "linux","agentStateCode": "在线","agentGuid": "F091C368-4ED9-4F18-8D48-06610CB5D4FC","hostId": 131529,"type": "vm","guardStatus": "防护中","regionName": "北京5","sshRisk": 0,"vulRisk": 0,"wpRisk": 0,"scaRisk": 0,"virusRisk": 0,"riskStatus": "安全","quotaVersion": 2}],"pageNum": 1,"pageSize": 2,"size": 0,"startRow": 0,"endRow": 0,"pages": 5256,"prePage": 0,"nextPage": 0,"isFirstPage": false,"isLastPage": false,"hasPreviousPage": false,"hasNextPage": false,"navigatePages": 0,"navigatepageNums": null,"navigateFirstPage": 0,"navigateLastPage": 0},"success": false}
状态码
请参考 状态码
错误码
请参考 错误码
