文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 查询漏洞扫描策略 - ShowVulScanPolicy
更新时间:2025-10-31 GMT+08:00
分享

查询漏洞扫描策略 - ShowVulScanPolicy

功能介绍

查询漏洞扫描策略

授权信息

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

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

URI

GET /v5/{project_id}/vulnerability/scan-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

主机所属的企业项目ID。

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

企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

scan_period

String

扫描周期

  • one_day : 每天

  • three_day : 每三天

  • one_week : 每周

scan_vul_types

Array of strings

扫描的漏洞类型列表

scan_range_type

String

扫描主机的范围,包含如下:

-all_host : 扫描全部主机

-specific_host : 扫描指定主机

host_ids

Array of strings

主机ID列表;当scan_range_type的值为specific_host时表示扫描的主机列表

total_host_num

Long

可进行漏洞扫描的主机总数

status

String

扫描策略状态,包含如下:

-open : 开启

-close : 关闭

请求示例

查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的漏洞扫描策略

GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/scan-policy

响应示例

状态码:200

请求已成功

{
  "scan_period" : "one_day",
  "scan_vul_types" : [ "linux_vul" ],
  "scan_range_type" : "specific_host",
  "host_ids" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ],
  "total_host_num" : 5,
  "status" : "open"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档