You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_ASSET_HOST
GetHostBasicInfo - 获取主机基础信息
复制全文
下载 pdf
GetHostBasicInfo - 获取主机基础信息

根据 AgentID 获取单台主机的系统、网络、客户端、防护状态和各类安全风险统计;AgentID 为必填,TopGroupID 不传时不限制根分组。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

GetHostBasicInfo

要执行的操作,取值:GetHostBasicInfo。

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

AgentID
String
否

agent-id-001

主机 ID,可通过 ListHostsAgentIDs 接口获取

TopGroupID
String
否

group-id-001

根分组 ID,可通过多级分组查询接口获取;不传时不限制根分组

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Baseline
Object

--

基线检查结果数量,按风险级别及通过状态统计

State
String

success

主机状态

FirstHeartbeatTime
Long

1786533780

客户端安装时间,Unix 时间戳,单位:秒

Reason
String

--

原因

GroupPathEn
String

/group1/group2

主机分组英文路径

AgentID
String

agent-id-001

主机ID

CloudProvider
String

volcengine

云厂商

KernelVersion
String

1.0.0

内核版本

LastHeartbeatTime
Long

1786533780

最近活跃时间,Unix 时间戳,单位:秒

Online
Boolean

true

是否在线

RealRiskVul
Object

--

真实风险漏洞数量,按严重级别统计

CpuUsage
Double

0.95

Cpu使用率

Platform
String

linux

操作系统

UserStatus
String

start_succeed

用户操作状态。starting:启用中;stopping:停用中;start_failed:启用失败;stop_failed:停用失败;start_succeed:启用成功;stop_succeed:停用成功

Alarm
Object

--

安全告警数量,按严重级别统计

Dns
String

DNS

DNS

PlatformVersion
String

linux

操作系统版本

PluginsStatus
String

all_online

插件在线状态。all_online:全部在线;all_offline:全部离线;some_online:部分在线

TotalMem
Long

8589934592

物理内存大小,单位:字节

Vuln
Object

--

待处理漏洞数量,按严重级别统计

AbnormalPluginsList
String

collector: offline

插件异常信息

EcsInstance
Object

--

ecs字段

Gateway
String

192.0.2.1

网关

OldValidCode
Long

1

老版本Agent在线状态

PluginsBriefInfo
String

collector 1.0.0 online

插件

SecurityEnhancement
Boolean

true

安全防护开关是否开启

UserStatusReasonCode
Long

0

失败原因状态 Code

StartTime
Long

1786533780

启动时间,Unix 时间戳,单位:秒

ClientPublicIP
String

192.0.2.10

出口IP

CollectStatus
Boolean

true

资产指纹采集状态。true:允许采集;false:不允许采集

Group
String

default-group

主机分组

GroupPath
String

/group1/group2

分组路径,格式:/group1/group2/group3

MemUsage
Double

0.95

内存使用率

AccountID
String

account-id-001

租户ID

Status
String

Protecting

防护状态,Protecting: 防护中 ProtectionException:防护异常 Unprotected: 未防护 Offline:已关机

StateDetail
String

success

主机状态详情

Tags
Array of String

["production"]

主机标签

UserStatusReason
String

success

失败原因状态

Virus
Object

--

病毒文件数量,按严重级别统计

请求示例

GET /?Action=GetHostBasicInfo&Version=2024-05-08&AgentID=agent-id-001&TopGroupID=group-id-001 HTTP/1.1
Host: seccenter.volcengineapi.com
X-Date: 20241120T080538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetHostBasicInfo",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AbnormalPluginsList": "collector: offline",
    "AccountID": "account-id-001",
    "AgentID": "agent-id-001",
    "Alarm": {
      "Critical": 1,
      "High": 1,
      "Low": 1,
      "Medium": 1
    },
    "Baseline": {
      "High": 1,
      "Low": 1,
      "Medium": 1,
      "Pass": 1
    },
    "ClientPublicIP": "192.0.2.10",
    "CloudProvider": "volcengine",
    "CollectStatus": true,
    "CpuUsage": 0.95,
    "Dns": "DNS",
    "EcsInstance": {
      "AccessKey": "AKLTEXAMPLE001",
      "AccountID": "account-id-001",
      "Cpu": 1,
      "CreatedAt": "2024-05-08T10:00:00Z",
      "ECSUpdateAt": "2024-05-08T10:00:00Z",
      "EipAddress": "192.0.2.10",
      "HostName": "host-001",
      "IPList": [
        "192.0.2.10"
      ],
      "InstanceName": "example-name",
      "Mem": 1,
      "OsName": "veLinux 1.0 64位",
      "OsType": "veLinux",
      "Platform": "Linux",
      "PlatformVersion": "1.0",
      "PrimaryIpAddress": "192.0.2.10",
      "Region": "cn-beijing",
      "SecurityEnhancementStrategy": "security-enhancement-strategy-sample",
      "Status": "RUNNING",
      "Visibility": "visibility-sample",
      "VpcId": "vpc-id-001",
      "VpcName": "example-name",
      "ZoneId": "cn-beijing-a"
    },
    "FirstHeartbeatTime": 1786533780,
    "Gateway": "192.0.2.1",
    "Group": "default-group",
    "GroupPath": "/group1/group2",
    "GroupPathEn": "/group1/group2",
    "KernelVersion": "1.0.0",
    "LastHeartbeatTime": 1786533780,
    "MemUsage": 0.95,
    "OldValidCode": 1,
    "Online": true,
    "Platform": "linux",
    "PlatformVersion": "linux",
    "PluginsBriefInfo": "collector 1.0.0 online",
    "PluginsStatus": "all_online",
    "RealRiskVul": {
      "Critical": 1,
      "High": 1,
      "Low": 1,
      "Medium": 1,
      "Unknown": 1
    },
    "Reason": "--",
    "SecurityEnhancement": true,
    "StartTime": 1786533780,
    "State": "success",
    "StateDetail": "success",
    "Status": "Protecting",
    "Tags": [
      "production"
    ],
    "TotalMem": 8589934592,
    "UserStatus": "start_succeed",
    "UserStatusReason": "success",
    "UserStatusReasonCode": 0,
    "Virus": {
      "Critical": 1,
      "High": 1,
      "Low": 1,
      "Medium": 1
    },
    "Vuln": {
      "Critical": 1,
      "High": 1,
      "Low": 1,
      "Medium": 1,
      "Unknown": 1
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.10.30 14:06:11
这个页面对您有帮助吗?
有用
有用
无用
无用