文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 查询处理对应的主机存储库的列表 - ListVulHostVaults
更新时间:2025-10-31 GMT+08:00
分享

查询处理对应的主机存储库的列表 - ListVulHostVaults

功能介绍

查询处理对应的主机存储库的列表

授权信息

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

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

URI

GET /v5/{project_id}/vulnerability/backup/host-vaults

表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)。

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

backup_info_id

String

参数解释:

本次漏洞处置对应的备份信息id

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

取值0-10000

data_list

Array of HostVaultInfo objects

参数解释:

主机存储库信息列表

取值范围:

不涉及

表5 HostVaultInfo

参数

参数类型

描述

host_id

String

参数解释:

主机id

取值范围:

字符长度1-128位

host_name

String

参数解释:

主机名称

取值范围:

字符长度1-256位

public_ip

String

参数解释:

主机公网ip

取值范围:

字符长度1-128位

private_ip

String

参数解释:

主机私网ip

取值范围:

字符长度1-128位

asset_value

String

参数解释:

主机的资产重要性

取值范围:

  • important:重要资产

  • common:一般资产

  • test:测试资产

default_backup_name_suffix

String

参数解释:

默认备份名称的后缀

取值范围:

字符长度0-32位

default_vault

default_vault object

参数解释:

默认选中的存储库

取值范围:

不涉及

vaults

Array of vaults objects

参数解释:

主机的存储库列表

取值范围:

不涉及

表6 default_vault

参数

参数类型

描述

vault_name

String

参数解释:

存储库名称

取值范围:

字符长度1-128位

vault_id

String

参数解释:

存储库id

取值范围:

字符长度1-128位

表7 vaults

参数

参数类型

描述

vault_name

String

参数解释:

存储库名称

取值范围:

字符长度1-128位

vault_id

String

参数解释:

存储库id

取值范围:

字符长度1-128位

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "caxxxxad-xxxx-4d46-xxxx-686xxxxxx515",
    "host_name" : "my-host",
    "public_ip" : "100.99.9.9",
    "private_ip" : "192.168.9.9",
    "asset_value" : "common",
    "default_backup_name_suffix" : "a09f",
    "default_vault" : {
      "vault_id" : "b4xxxxa1-xxxx-402d-xxxx-124xxxxxx1e0",
      "vault_name" : "vault-4f87"
    },
    "vaults" : [ {
      "vault_id" : "b4xxxxa1-xxxx-402d-xxxx-124xxxxxx1e0",
      "vault_name" : "vault-4f87"
    } ]
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档