接口功能介绍
服务器列表-根据云主机id查询主机防护状态接口。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
POST /v1/host/cloud/guard/statusQuery/query
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cloudHostIds | 否 | Array of Strings | 主机id，不传则不查询任何数据 | ["10111"] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码CTCSSCN_000000 :成功;CTCSSCN_000001:失败;CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用;CTCSSCN_000004：鉴权错误;CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | data |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| hosts | Array of Objects | 主机列表 | host |
表 host
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentIp | String | 私网IP | 1.1.1.1 | |
| publicIp | String | 公网IP | 1.1.1.1 | |
| custName | String | 服务器名称 | ||
| hostName | String | 主机名 | ||
| osType | String | 操作系统类型 | ||
| agentStateCode | String | Agent状态12-在线,13-离线，14-从未连接，15-未激活，16-agent错误，17-Center错误 | ||
| agentGuid | String | agentGuid | ||
| hostUid | String | 云主机id | ||
| type | String | 服务器类型 | ||
| guardStatus | String | 防护状态 防护中/未防护 | ||
| guardStatusCode | String | 防护状态编码1-防护中，4-未防护 | ||
| regionName | String | 地域 | 南京3 | |
| quotaVersion | String | 配额版本2基础版，3企业版 | ||
| quotaVersionName | String | 配额版本名称企业版 -基础版 | ||
| viewUrl | String | 查看连接 | http:// |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"cloudHostIds": ["1997418177"]}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"hosts": {"cloudHostId": "9a659f9b-c8a1-4841-9342-8995f7b9e15e","agentGuid": "9A659F9B-C8A1-4841-9342-8995F7B9E15E","quotaVersion": 1,"quotaVersionName": "基础版","guardStatusCode": 1,"guardStatus": "防护中","viewUrl": "https://ctcss.ctyun.cn/v2/eShield#/safety/cds/serverDetails?guid=9A659F9B-C8A1-4841-9342-8995F7B9E15E"}}}
状态码
请参考 状态码
错误码
请参考 错误码
