查询服务器详情
更新时间 2025-12-25 11:51:10
最近更新时间: 2025-12-25 11:51:10
接口功能介绍
获取服务器详细信息。
接口约束
已经签约安全卫士服务协议
URI
GET /v1/host/detail/*
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| agentGuid | 是 | String | agentGuid |
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 |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| custName | String | 主机名称 | test | |
| hostName | String | 实例名称 | test | |
| displayName | String | 实例名称 | test | |
| agentGuid | String | agentGuid | test | |
| azName | String | 所在az | test | |
| publicIp | String | 公网IP | ||
| ipAddress | String | 私网IP | 192.168.1.1 | |
| regionName | String | 所在区域 | test | |
| stateName | String | 防护状态 | 防护中 | |
| guardStatus | Object | 防护状态 | guardStatus | |
| createDate | String | 创建日期 | 2020-01-01 00:00:00 | |
| expireDate | String | 过期时间 | 2020-01-01 00:00:00 | |
| bgGroupName | String | 所属分组 | 事业部/产品线 | |
| osType | String | 操作系统 Windows/Linux | Linux | |
| osTypeCode | String | 操作系统 Windows/Linux | Linux | |
| agentInfo | Object | agent信息 | agentInfo | |
| startTime | String | 启动时间 | 2020-01-01 00:00:00 | |
| serverGroup | String | 云主机组 | test | |
| safeGroup | String | 安全组 | test | |
| registrationTime | String | 注册时间 | 2020-01-01 00:00:00 | |
| expireTime | String | 过期时间 | 2020-01-01 00:00:00 | |
| notSupportVulFixReason | String | 不支持漏洞修复的原因 | 不支持漏洞修复的原因 | |
| notSupportVulFixCode | Integer | 不支持漏洞修复的原因编码 0-支持修复 1-机器已删除,不支持修复 2-该漏洞类型不支持修复 3-基础版不支持漏洞修复,请升级至企业版或旗舰版 | ||
| 4-漏洞修复功能灰度中暂时不支持修复 5-agent版本低不支持修复,请升级 6-下发修复命令异常,不支持修复 7-服务器上没有yum/apt命令 | ||||
| 8-服务器上yum/apt命令当前不可用 9-服务器无法连接软件源 10-服务器无法连接微软官方服务器 11-Agent已离线,不支持修复 12-系统仅支持扫描,暂不支持自动修复 | 0 | |||
| supportVulFix | Integer | 是否支持漏洞修复,0-不支持修复 1-支持修复 | 0 | |
| containerName | String | 镜像名称 | test | |
| diskNum | Integer | 磁盘数量 | 0 | |
| netNum | Integer | 网卡数量 | 0 | |
| vpcName | String | vpc名称 | test | |
| serialNumber | String | 序列号 | test | |
| memTotal | String | 总内存量,单位GB | 0 | |
| systemLoad | Integer | 系统负载 | 0 | |
| usageRate | String | cpu使用率 | 0.36 | |
| productName | String | 设备型号 | test | |
| cpuInfoList | Array of Objects | CPU信息 | cpuInfoList | |
| diskInfoList | Array of Objects | 磁盘信息 | diskInfoList | |
| netInfoList | Array of Objects | 网卡信息 | netInfoList | |
| osNameVersion | String | 如centos 7.6 | ||
| 操作系统名称及版本 | centos 7.6 | |||
| agentVersion | String | 如v4.11.1 | ||
| agent版本 | v4.11.1 | |||
| proxyAddress | String | 代理地址,安装agent时,用户可配置自己的代理服务,转发agent请求到安全卫士到后台 | 169.254.169.254 | |
| 表 netInfoList |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 网卡名称 | eth0 | |
| netMask | String | 网卡子网掩码 | 255.255.255.0 | |
| ipv4 | String | IPv4地址 | 192.168.1.1 | |
| ipv6 | String | IPv6地址 | fe80::a00:27ff:fea5:c0c5 | |
| hardwareAddr | String | MAC地址 | 00:05:a5:c0:c5:0a | |
| gateWay | String | 默认网关 | 192.168.1.1 | |
| broadcastaddr | String | 广播地址 | 192.168.1.255 | |
| flag | String | 网卡标志 | up | |
| 表 diskInfoList |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskName | String | 分区名 | /dev/sda1 | |
| mountPoint | String | 挂载目录 | / | |
| fileSystemType | String | 文件系统类型 | ext4 | |
| total | String | 磁盘总空间,单位GB | 100 | |
| used | String | 已使用空间,单位GB | 50 | |
| usage | String | 磁盘使用率,单位% | 50 | |
| 表 cpuInfoList |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| modelName | String | cpu型号 | Intel Xeon Processor (Icelake) | |
| vendorId | String | cpu生产商 | GenuineIntel | |
| cores | Integer | cpu核数 | 4 | |
| mHz | String | cpu频率,单位MHz | 2600 | |
| 表 agentInfo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| installPath | String | 安装路径 | /var/ctcss | |
| user | String | 运行账号 | ctcss | |
| chown | String | 运行权限 | 755 | |
| confPath | String | 配置文件路径 | /var/ctcss/etc/ctcss.yml | |
| logPath | String | 日志路径 | /var/ctcss/logs/ctcss-agentd.log | |
| processNames | Array of Strings | 相关进程 | ["ctcss-agentd", "eShield-modules"] | |
| 表 guardStatus |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | Integer | 状态码 1-防护中 4-未防护 | 1 | |
| msg | String | 状态信息 | 防护中 | |
| value | String | 状态值 | 防护中 |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{}
响应示例
{"message": "success", "traceId": "211111111111111111111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"custName": "test", "hostName": "test", "displayName": "test", "agentGuid": "test", "azName": "test", "publicIp": "", "ipAddress": "192.168.1.1", "regionName": "test", "stateName": "防护中", "guardStatus": {"code": 1, "msg": "防护中", "value": "防护中"}, "createDate": "2020-01-01 00:00:00", "expireDate": "2020-01-01 00:00:00", "bgGroupName": "事业部/产品线", "osType": "Linux", "osTypeCode": "Linux", "agentInfo": {"installPath": "/var/ctcss", "user": "ctcss", "chown": "755", "confPath": "/var/ctcss/etc/ctcss.yml", "logPath": "/var/ctcss/logs/ctcss-agentd.log", "processNames": ["ctcss-agentd", "eShield-modules"]}, "startTime": "2020-01-01 00:00:00", "serverGroup": "test", "safeGroup": "test", "registrationTime": "2020-01-01 00:00:00", "expireTime": "2020-01-01 00:00:00", "notSupportVulFixReason": "不支持漏洞修复的原因", "notSupportVulFixCode": 0, "supportVulFix": 0, "containerName": "test", "diskNum": 0, "netNum": 0, "vpcName": "test", "serialNumber": "test", "memTotal": "0", "systemLoad": 0, "usageRate": "0.36", "productName": "test", "cpuInfoList": [{"modelName": "Intel Xeon Processor (Icelake)", "vendorId": "GenuineIntel", "cores": 4, "mHz": "2600"}], "diskInfoList": [{"diskName": "/dev/sda1", "mountPoint": "/", "fileSystemType": "ext4", "total": "100", "used": "50", "usage": "50"}], "netInfoList": [{"name": "eth0", "netMask": "255.255.255.0", "ipv4": "192.168.1.1", "ipv6": "fe80::a00:27ff:fea5:c0c5", "hardwareAddr": "00:05:a5:c0:c5:0a", "gateWay": "192.168.1.1", "broadcastaddr": "192.168.1.255", "flag": "up"}], "osNameVersion": "centos 7.6", "agentVersion": "v4.11.1", "proxyAddress": "169.254.169.254"}}
状态码
请参考 状态码
错误码
请参考 错误码