查询主机防护状态
更新时间 2025-12-24 16:08:38
最近更新时间: 2025-12-24 16:08:38
接口功能介绍
服务器列表-根据云主机id查询主机防护状态接口。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
POST /v1/host/cloud/guard/statusQuery/query
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cloudHostIds | 是 | Array of Strings | 云主机id列表 | ["111","222"] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000：成功 | ||||
| CTCSSCN_000001：失败 | ||||
| CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004：鉴权错误 | ||||
| CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | asaadasd11111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| key | Array of Objects | key | ||
| 表 key |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentIp | String | 内网IP | 10.10.10.10 | |
| publicIp | String | 公网IP | 10.10.10.10 | |
| custName | String | 主机名称 | ctc-ass | |
| hostName | String | 实例名称 | ctc-ass | |
| osType | String | 操作系统类型 Linux/Windows | Linux | |
| agentStateCode | String | Agent状态 12-在线 13-离线 | 12 | |
| agentGuid | String | agentGuid | 11111111111111111111111111111111 | |
| hostUid | String | 云主机控制台实例id | 11111111111111111111111111111111 | |
| type | String | 服务器类型 vm-虚拟机 pm-物理机 | vm | |
| guardStatus | String | 防护状态 防护中/未防护 | 未防护 | |
| guardStatusCode | Integer | 防护状态code 1-防护中 4-未防护 | 1 | |
| regionName | String | 地域 | 杭州 | |
| quotaVersion | Integer | 配额版本 1-基础版 2-企业版 3-旗舰版 | 1 | |
| quotaVersionName | String | 配额版本名称 基础版 | 企业版 | 旗舰版 |
| viewUrl | String | 查看连接 | http://10.10.10.10:8080/ |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"cloudHostIds": ["111", "222"]}
响应示例
{"message": "success", "traceId": "asaadasd11111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"key": [{"agentIp": "10.10.10.10", "publicIp": "10.10.10.10", "custName": "ctc-ass", "hostName": "ctc-ass", "osType": "Linux", "agentStateCode": "12", "agentGuid": "11111111111111111111111111111111", "hostUid": "11111111111111111111111111111111", "type": "vm", "guardStatus": "未防护", "guardStatusCode": 1, "regionName": "杭州", "quotaVersion": 1, "quotaVersionName": "基础版", "viewUrl": "http://10.10.10.10:8080/"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
