查询Web防护漏洞情报 - ListVulnRules
功能介绍
查询Web防护漏洞情报
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/waf/vulnerability/notification
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围: 默认取值: 0 |
| offset | 否 | Integer | 参数解释: 分页查询的起始位置,表示从第几条记录开始返回 约束限制: 不涉及 取值范围: [0,2147483645] 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 分页查询的单页返回数量,控制每次请求返回的记录条数。 约束限制: 不涉及 取值范围: [1, 1000] 默认取值: 10 |
| from | 否 | Long | 参数解释: 起始时间(13位毫秒时间戳),需要和to同时使用。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| to | 否 | Long | 参数解释: 结束时间(13位毫秒时间戳),需要和from同时使用。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 否 | String | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
| X-Language | 否 | String | 参数解释: 语言类型 约束限制: 不涉及 取值范围: 默认取值: zh-cn |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of VulnDto objects | 漏洞信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| vulnerability_id | String | 漏洞编号 |
| description | String | 漏洞描述 |
| rule_ids | Array of strings | 可防护的规则ID列表 |
| create_time | Long | 漏洞情报创建时间 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
查询漏洞详情
GET https://{Endpoint}/v1/{project_id}/waf/vulnerability/notification?lenterprise_project_id=0 响应示例
状态码:200
漏洞列表
[ {
"vulnerability_id" : "vulnerability_id_e43ac72f21d8",
"description" : "description_a076185391e2",
"rule_ids" : [ "rule_ids_5c3538f51631" ],
"create_time" : 0
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 漏洞列表 |
| 400 | 请求失败 |
| 401 | token权限不足 |
| 500 | 服务器内部错误 |
错误码
请参见错误码。