接口功能介绍
获取服务器详细信息。
接口约束
已经签约安全卫士服务协议
URI
GET /v1/host/detail/*
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| agentGuid | 是 | String | 计算机agentGuid | aba2f4cd-3161-4251-a382-8dc7866f0d4d |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码CTCSSCN_000000 :成功;CTCSSCN_000001:失败;CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用;CTCSSCN_000004：鉴权错误;CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | map |
表 map
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| custName | String | 名称 | ecm-waf-lvs | |
| agentGuid | String | UUID | F091C368-4ED9-4F18-8D48-06610CB5D4FC | |
| regionName | String | 地区名称 | 北京5 | |
| publicIp | String | 公网IP | 10.104.1.226 | |
| ipAddress | String | 内网IP | 10.104.1.228 | |
| azName | String | 所在AZ | az名称 | |
| statusName | String | 防护状态，防护中|已离线|未防护|已关闭 | 已离线 | |
| createDate | String | 创建时间 | Tue Aug 16 11:34:04 CST 2022 | |
| expireDate | String | 过期时间 | Mon Aug 16 11:34:04 CST 2027 | |
| osType | String | 操作系统 | Linux |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"Content-Type":"application/json",
"urlType": "CTAPI"
}
请求体body
无
响应示例
{
"statusCode": "200",
"error": "CTCSSCN_000000",
"message": "查询成功!",
"returnObj":{
"custName": "ecm-waf-lvs",
"agentGuid": "F091C368-4ED9-4F18-8D48-06610CB5D4FC",
"azName": null,
"publicIp": "",
"ipAddress": "10.104.1.226",
"regionName": "北京5",
"stateName": "防护中",
"createDate": "Tue Aug 16 11:34:04 CST 2022",
"expireDate": "Mon Aug 16 11:34:04 CST 2027",
"osType": "linux"
},
"success": false
}
状态码
请参考 状态码
错误码
请参考 错误码
