查询漏洞扫描策略 - ShowVulScanPolicy
功能介绍
查询漏洞扫描策略
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/scan-policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
scan_period |
String |
参数解释: 扫描周期 取值范围:
|
|
scan_vul_types |
Array of strings |
参数解释: "扫描的漏洞类型列表" 取值范围: 最小值0，最大值5 |
|
scan_range_type |
String |
参数解释: 扫描主机的范围 取值范围:
|
|
host_ids |
Array of strings |
参数解释: 主机ID列表；当scan_range_type的值为specific_host时表示扫描的主机列表 取值范围: 最小值0，最大值20000 |
|
total_host_num |
Long |
参数解释: 可进行漏洞扫描的主机总数 取值范围: 最小值0，最大值20000 |
|
status |
String |
参数解释: 扫描策略状态 取值范围:
|
|
time |
time object |
参数解释: 扫描时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
day_part |
Array of integers |
参数解释: 扫描日期或者星期列表 取值范围: 最小值0，最大值31 |
|
hour_part |
Integer |
参数解释: 扫描时间的小时部分 取值范围: 最小值0，最大值11 |
|
minute_part |
Integer |
参数解释: 扫描时间的分钟部分 取值范围: 最小值0，最大值59 |
|
next_scan_time |
Long |
参数解释: 下一次扫描时间 取值范围: 最小值0，最大值2^63-1 |
|
timezone_offset |
Integer |
参数解释: 距离标准时区的差值，如东八区（GMT+8）为-480 取值范围: 最小值-840，最大值720 |
请求示例
查询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 |
请求已成功 |
错误码
请参见错误码。
