查询Agent防护状态统计数据
更新时间 2025-12-25 13:12:59
最近更新时间: 2025-12-25 13:12:59
接口功能介绍
主机总数：该客户的服务器总数，包括所有的云主机和物理机，无论是否防护都需要统计。防护中：防护状态为“防护中”的服务器数量统计。已离线：防护状态为“已离线”的数量统计。已关闭：防护状态为“已关闭”的数量统计。未防护：防护状态为“未防护”的数量统计。基础版防护：服务器配额为基础版的服务器数量。企业版防护：服务器配额为企业版的服务器数量。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
GET /v1/index/status
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | 服务器总数 | 1 | |
| unGuard | Integer | 未安装，未防护服务器数量（未激活） | 1 | |
| offLine | Integer | 离线服务器数量（Agent离线或错误） | 1 | |
| guard | Integer | 防护中服务器数量(Agent在线且开启防护) | 1 | |
| closedGuard | Integer | 关闭防护（Agent在线且关闭防护）数量 | 1 | |
| baseGuard | Integer | 基础版防护数量 | 1 | |
| enterpriseGuard | Integer | 企业版防护数量 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{}
响应示例
{"message": "success", "traceId": "211111111111111111111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"total": 1, "unGuard": 1, "offLine": 1, "guard": 1, "closedGuard": 1, "baseGuard": 1, "enterpriseGuard": 1}}
状态码
请参考 状态码
错误码
请参考 错误码
