添加漏洞白名单 - AddVulWhiteList
功能介绍
添加漏洞白名单
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/vulnerability/white-list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
vul_type |
是 |
String |
参数解释: 漏洞类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
vul_ids |
是 |
Array of strings |
参数解释: 漏洞ID列表 约束限制: 不涉及 取值范围: 最小值1,最大值500 默认取值: 不涉及 |
|
rule_type |
是 |
String |
参数解释: 白名单规则类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
host_ids |
否 |
Array of strings |
参数解释: 主机ID列表,当rule_type为specific_host时,该字段必填 约束限制: 不涉及 取值范围: 最小值1,最大值2000 默认取值: 不涉及 |
|
with_ignore |
否 |
Boolean |
参数解释: 是否忽略当前已扫描出的漏洞 约束限制: 不涉及 取值范围:
默认取值: true |
|
description |
否 |
String |
参数解释: 白名单的描述信息 约束限制: 不涉及 取值范围: 字符长度0-1000 默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
新增漏洞白名单
POST https://{endpoint}/v5/{project_id}/vulnerability/white-list?enterprise_project_id=all_granted_eps
{
"vul_type" : "linux_vul",
"vul_ids" : [ "Alpinev3.10-main-apk-tools-2.10.7-r0" ],
"rule_type" : "specific_host",
"description" : "description",
"host_ids" : [ "b5d8f811-1be6-4630-8312-8513860e02cc" ]
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。