主机安全服务(新版)HSS-查询云服务器列表:响应参数

时间:2023-12-25 17:37:39

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

最小值:0

最大值:2097152

data_list

Array of Host objects

查询弹性云服务器状态列表

数组长度:0 - 10241

表5 Host

参数

参数类型

描述

host_name

String

服务器名称

最小长度:0

最大长度:128

host_id

String

服务器ID

最小长度:0

最大长度:128

agent_id

String

Agent ID

最小长度:0

最大长度:128

private_ip

String

私有IP地址

最小长度:0

最大长度:128

public_ip

String

弹性公网IP地址

最小长度:0

最大长度:128

enterprise_project_id

String

企业项目ID

最小长度:0

最大长度:256

enterprise_project_name

String

所属企业项目名称

最小长度:0

最大长度:256

host_status

String

服务器状态,包含如下4种。

  • ACTIVE :运行中。

  • SHUTOFF :关机。

  • BUILDING :创建中。

  • ERROR :故障。

最小长度:1

最大长度:32

agent_status

String

Agent状态,包含如下5种。

  • installed :已安装。

  • not_installed :未安装。

  • online :在线。

  • offline :离线。

  • install_failed :安装失败。

  • installing :安装中。

最小长度:1

最大长度:32

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 :架构类型错误。

最小长度:1

最大长度:32

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 :容器版。

最小长度:1

最大长度:32

protect_status

String

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

  • closed :未防护。

  • opened :防护中。

最小长度:1

最大长度:32

os_image

String

系统镜像

最小长度:0

最大长度:128

os_type

String

操作系统类型,包含如下2种。

  • Linux :Linux。

  • Windows :Windows。

最小长度:0

最大长度:128

os_bit

String

操作系统位数

最小长度:0

最大长度:128

detect_result

String

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

  • undetected :未检测。

  • clean :无风险。

  • risk :有风险。

  • scanning :检测中。

最小长度:1

最大长度:32

expire_time

Long

试用版到期时间(-1表示非试用版配额,当值不为-1时为试用版本过期时间)

最小值:0

最大值:4824695185000

charging_mode

String

收费模式,包含如下2种。

  • packet_cycle :包年/包月。

  • on_demand :按需。

最小长度:1

最大长度:32

resource_id

String

主机安全配额ID(UUID)

最小长度:0

最大长度:128

outside_host

Boolean

是否非华为云机器

group_id

String

服务器组ID

最小长度:1

最大长度:128

group_name

String

服务器组名称

最小长度:1

最大长度:128

policy_group_id

String

策略组ID

最小长度:1

最大长度:128

policy_group_name

String

策略组名称

最小长度:1

最大长度:128

asset

Integer

资产风险

最小值:0

最大值:2097152

vulnerability

Integer

漏洞风险

最小值:0

最大值:2097152

baseline

Integer

基线风险

最小值:0

最大值:2097152

intrusion

Integer

入侵风险

最小值:0

最大值:2097152

asset_value

String

资产重要性,包含如下4种

  • important :重要资产

  • common :一般资产

  • test :测试资产

最小长度:0

最大长度:128

labels

Array of strings

标签列表

最小长度:0

最大长度:64

数组长度:0 - 100

agent_create_time

Long

agent安装时间,采用时间戳,默认毫秒,

最小值:0

最大值:4824695185000

agent_update_time

Long

agent状态修改时间,采用时间戳,默认毫秒,

最小值:0

最大值:4824695185000

agent_version

String

agent版本

最小长度:1

最大长度:32

upgrade_status

String

升级状态,包含如下4种。

  • not_upgrade :未升级,也就是默认状态,客户还没有给这台机器下发过升级。

  • upgrading :正在升级中。

  • upgrade_failed :升级失败。

  • upgrade_succeed :升级成功。

最小长度:1

最大长度:32

upgrade_result_code

String

升级失败原因,只有当 upgrade_status 为 upgrade_failed 时才显示,包含如下6种。

  • package_unavailable :升级包解析失败,升级文件有错误。

  • network_access_timeout :下载升级包失败,网络异常。

  • agent_offline :agent离线。

  • hostguard_abnormal :agent工作进程异常。

  • insufficient_disk_space :磁盘空间不足。

  • failed_to_replace_file :替换文件失败。

最小长度:1

最大长度:32

upgradable

Boolean

该服务器agent是否可升级

open_time

Long

开启防护时间,采用时间戳,默认毫秒,

最小值:0

最大值:4824695185000

protect_interrupt

Boolean

防护是否中断

support.huaweicloud.com/api-hss2.0/ListHostStatus.html