文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 主机管理/ ECS风险状况 - ListHostsRisk
更新时间:2025-10-31 GMT+08:00
分享

ECS风险状况 - ListHostsRisk

功能介绍

ECS风险状况

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/host-management/hosts-risk

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

host_id_list

Array of strings

主机ID列表

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of HostRiskResponseInfo objects

查询ECS风险列表

表5 HostRiskResponseInfo

参数

参数类型

描述

host_id

String

服务器ID

agent_status

String

Agent状态,包含如下5种。

  • not_installed :未安装。

  • online :在线。

  • offline :离线。

  • install_failed :安装失败。

  • installing :安装中。

install_result_code

String

安装结果,包含如下12种。

  • install_succeed :安装成功。

  • network_access_timeout :网络不通,访问超时。

  • invalid_port :无效端口。

  • auth_failed :认证错误,口令不正确。

  • permission_denied :权限错误,被拒绝。

  • no_available_vpc :没有相同VPC的agent在线虚拟机。

  • install_exception :安装异常。

  • invalid_param :参数错误。

  • install_failed :安装失败。

  • package_unavailable :安装包失效。

  • os_type_not_support :系统类型错误。

  • os_arch_not_support :架构类型错误。

version

String

主机开通的版本,包含如下7种输入。

  • hss.version.null :无。

  • hss.version.basic :基础版。

  • hss.version.advanced :专业版。

  • hss.version.enterprise :企业版。

  • hss.version.premium :旗舰版。

  • hss.version.wtp :网页防篡改版。

  • hss.version.container.enterprise :容器版。

protect_status

String

防护状态,包含如下2种。

  • closed :未防护。

  • opened :防护中。

detect_result

String

云主机安全检测结果,包含如下4种。

  • undetected :未检测。

  • clean :无风险。

  • risk :有风险。

  • scanning :检测中。

asset

Integer

资产风险

vulnerability

Integer

漏洞风险

baseline

Integer

基线风险

intrusion

Integer

入侵风险

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档