# 查询攻击事件列表 - ListEvent #### 功能介绍 查询攻击事件列表，该API暂时不支持查询全部防护事件，pagesize参数不可设为-1，由于性能原因，数据量越大消耗的内存越大，后端最多限制查询10000条数据，例如：自定义时间段内的数据超过了10000条，就无法查出page为101，pagesize为100之后的数据，需要调整时间区间，再进行查询 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-waf/waf_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-waf/waf_02_0119.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | waf:event:get | Read | - | g:EnterpriseProjectId | - | - | #### URI GET /v1/{project_id}/waf/event 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，对应华为云控制台用户名-\>我的凭证-\>项目列表-\>项目ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。 | | recent | 否 | String | **参数解释：** 查询日志的时间范围，recent参数与from、to必须使用其中一个。当同时使用recent参数与from、to时，以recent参数为准 **约束限制：** 不涉及 **取值范围：** - yesterday：昨天 - today：今天 - 3days：近3天 - 1week：近7天 - 1month：近30天 **默认取值：** 不涉及 | | from | 否 | Long | **参数解释：** 起始时间(毫秒时间戳)，需要和to同时使用 **约束限制：** from \<= to **取值范围：** from \~ to 最大范围30天 **默认取值：** 不涉及 | | to | 否 | Long | **参数解释：** 结束时间(毫秒时间戳)，需要和from同时使用 **约束限制：** from \~ to 最大范围30天 **取值范围：** 不能超过当天的结束时间 **默认取值：** 不涉及 | | ids | 否 | Array of strings | **参数解释：** 防护事件id列表，支持模糊查询 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nids | 否 | Array of strings | **参数解释：** 防护事件id列表（排除搜索），支持模糊查询 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | attacks | 否 | Array of strings | **参数解释：** 攻击类型 **约束限制：** 不涉及 **取值范围：** - xss：XSS攻击 - botm：BOT攻击 - webshell：网站木马 - vuln：其他漏洞攻击 - sqli：sql注入攻击 - robot：恶意爬虫 - rfi：远程文件包含 - rce：远程代码执行 - ptr：目录遍历 - lfi：本地文件包含 - antileakage：网站信息泄漏 - iprank：IP信誉库 - custom_whiteblackip：IP黑白名单 - custom_whiteip：白名单 - custom_blackip：黑名单 - custom_robot：扫描器爬虫 - custom_geoip：地理访问控制 - custom_idc_ip：IDC情报 - custom_custom：精准防护 - cmdi：命令注入攻击 - cc：cc攻击 - antitamper：网页防篡改 - anticrawler：网站反爬虫 - third_bot_river：第三方反爬虫 - antiscan_high_freq_scan：高频扫描封禁 - antiscan_dir_traversal：目录遍历防护 - illegal：非法请求 - followed_action：攻击惩罚 - advanced_bot：BOT管理 - llm_prompt_injection：提示词注入攻击 - llm_prompt_sensitive：提示词违规 - llm_response_sensitive：响应违规 **默认取值：** 不涉及 | | nattacks | 否 | Array of strings | **参数解释：** 攻击类型（排除搜索） **约束限制：** 不涉及 **取值范围：** - xss：XSS攻击 - botm：BOT攻击 - webshell：网站木马 - vuln：其他漏洞攻击 - sqli：sql注入攻击 - robot：恶意爬虫 - rfi：远程文件包含 - rce：远程代码执行 - ptr：目录遍历 - lfi：本地文件包含 - antileakage：网站信息泄漏 - iprank：IP信誉库 - custom_whiteblackip：IP黑白名单 - custom_whiteip：白名单 - custom_blackip：黑名单 - custom_robot：扫描器爬虫 - custom_geoip：地理访问控制 - custom_idc_ip：IDC情报 - custom_custom：精准防护 - cmdi：命令注入攻击 - cc：cc攻击 - antitamper：网页防篡改 - anticrawler：网站反爬虫 - third_bot_river：第三方反爬虫 - antiscan_high_freq_scan：高频扫描封禁 - antiscan_dir_traversal：目录遍历防护 - illegal：非法请求 - followed_action：攻击惩罚 - advanced_bot：BOT管理 - llm_prompt_injection：提示词注入攻击 - llm_prompt_sensitive：提示词违规 - llm_response_sensitive：响应违规 **默认取值：** 不涉及 | | rules | 否 | Array of strings | **参数解释：** 规则id列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nrules | 否 | Array of strings | **参数解释：** 规则id列表（排除搜索） **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sips | 否 | Array of strings | **参数解释：** 客户端IP列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nsips | 否 | Array of strings | **参数解释：** 客户端IP列表（排除搜索） **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sip | 否 | String | **参数解释：** 客户端IP，当query_mode为"equal"时为精确查询，否则模糊查询 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | urls | 否 | Array of strings | **参数解释：** url列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nurls | 否 | Array of strings | **参数解释：** url列表（排除搜索） **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | url | 否 | String | **参数解释：** URL，当query_mode为"equal"时为精确查询，否则模糊查询 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | actions | 否 | Array of strings | **参数解释：** 防护动作列表 **约束限制：** 不涉及 **取值范围：** - block：拦截 - pass：放行 - log：仅记录 - captcha：人机验证 - cache：不匹配 - mask：过滤 - js_challenge：JS挑战 - advanced_captcha：高级人机验证 - abort_response：中断响应 - desensitize：脱敏 **默认取值：** 不涉及 | | nactions | 否 | Array of strings | **参数解释：** 防护动作列表（排除搜索） **约束限制：** 不涉及 **取值范围：** - block：拦截 - pass：放行 - log：仅记录 - captcha：人机验证 - cache：不匹配 - mask：过滤 - js_challenge：JS挑战 - advanced_captcha：高级人机验证 - abort_response：中断响应 - desensitize：脱敏 **默认取值：** 不涉及 | | domain | 否 | String | **参数解释：** 域名，支持模糊查询 **约束限制：** domain和ndomain不可同时查询，当两个都存在时以domain为准 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ndomain | 否 | String | **参数解释：** 域名（排除搜索），支持模糊查询 **约束限制：** domain和ndomain不可同时查询，当两个都存在时以domain为准 **取值范围：** 不涉及 **默认取值：** 不涉及 | | domains | 否 | Array of strings | **参数解释：** 域名列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ip_countries | 否 | Array of strings | **参数解释：** 客户端IP所属国家列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nip_countries | 否 | Array of strings | **参数解释：** 客户端IP所属国家列表（排除搜索） **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ip_regions | 否 | Array of strings | **参数解释：** 客户端IP所属省份列表，仅中国省份生效 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nip_regions | 否 | Array of strings | **参数解释：** 客户端IP所属身份列表（排除搜索），仅中国省份生效 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | response_codes | 否 | Array of strings | **参数解释：** 响应码列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | payload | 否 | String | **参数解释：** 恶意负载（被WAF识别的攻击片段）： Web 基础防护(SQL注入、XSS、命令注入等)：被WAF识别的攻击片段 CC 攻击：命中规则的请求次数 精准防护、IP黑白名单、地理访问控制：空 攻击惩罚：命中攻击惩罚的用户标识 恶意爬虫：命中规则的 User-Agent 字段 网页反爬虫：JS 脚本事件：js_verified（JS 脚本验证通过事件）和 js_challenge（发送 JS 验证内容事件）。如果请求验证失败则为空。 网站信息泄露：敏感信息过滤为过滤类型，既电话号码,电子邮箱,身份证号；响应码拦截则为拦截的响应码值。 BOT攻击：命中规则的User-Agent等异常请求特征，或AI行为检测结果的评分细节 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hosts | 否 | Array of strings | **参数解释：** 域名id列表，从获取防护网站列表（ListHost）接口获取域名id **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | instances | 否 | Array of strings | **参数解释：** 引擎实例id列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | page | 否 | Integer | **参数解释：** 分页查询时，返回第几页数据 **约束限制：** 不涉及 **取值范围：** page参数的实际有效范围取决于总数据量和pagesize的取值，不能大于总页数 **默认取值：** 1 | | pagesize | 否 | Integer | **参数解释：** 分页查询时，每页包含的结果条数 **约束限制：** 不涉及 **取值范围：** \[0, 总数据量\] **默认取值：** 10 | | sort_key | 否 | String | **参数解释：** 排序字段，默认attack_time，选择其他字段时，会按照指定字段和attack_time共同排序 **约束限制：** 不涉及 **取值范围：** - attack_time 攻击时间 - sort_ip 客户端IP - host 域名 - geo_str 地理位置 - component 应用组件 - rule 规则ID - attack 事件类型（攻击类型） **默认取值：** attack_time | | sort_direction | 否 | String | **参数解释：** 排序方向 **约束限制：** 不涉及 **取值范围：** - desc 降序 - asc 升序 **默认取值：** desc | | query_mode | 否 | String | **参数解释：** 查询模式，仅影响参数sip、url **约束限制：** 不涉及 **取值范围：** - equal 精确查询 - include 模糊查询 **默认取值：** include | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | **参数解释：** 内容类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json;charset=utf8 | | X-Language | 否 | String | **参数解释：** 客户端IP所属地理位置展示语言，默认值为en-us **约束限制：** 不涉及 **取值范围：** - zh-cn 中文 - en-us 英文 **默认取值：** en-us | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 攻击事件数量 | | items | Array of [ListEventItems] objects | 攻击事件详情 | 表5ListEventItems | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 事件id | | time | Long | 攻击发生时的时间戳(毫秒) | | policyid | String | 策略id | | sip | String | 源ip，Web访问者的IP地址（攻击者IP地址） | | host | String | 域名 | | url | String | 攻击的url链接 | | attack | String | 攻击类型: - vuln：其它攻击类型 - sqli： sql注入攻击 - lfi： 本地文件包含 - cmdi：命令注入攻击 - xss：XSS攻击 - robot：恶意爬虫 - rfi：远程文件包含 - custom_custom：精准防护 - webshell：网站木马 - custom_whiteblackip：黑白名单拦截 - custom_geoip：地理访问控制拦截 - antitamper：防篡改 - anticrawler：反爬虫 - leakage：网站信息防泄露 - illegal：非法请求 - antiscan_high_freq_scan：高频扫描封禁 - antiscan_dir_traversal：目录遍历防护 | | rule | String | 命中的规则id | | payload | String | 恶意负载： Web 基础防护(SQL注入、XSS、命令注入等)：被WAF识别的攻击片段 CC 攻击：命中规则的请求次数 精准防护、IP黑白名单、地理访问控制：空 攻击惩罚：命中攻击惩罚的用户标识 恶意爬虫：命中规则的 User-Agent 字段 网页反爬虫：JS 脚本事件：js_verified（JS 脚本验证通过事件）和 js_challenge（发送 JS 验证内容事件）。如果请求验证失败则为空。 网站信息泄露：敏感信息过滤为过滤类型，既电话号码,电子邮箱,身份证号；响应码拦截则为拦截的响应码值。 BOT攻击：命中规则的User-Agent等异常请求特征，或AI行为检测结果的评分细节 | | payload_location | String | 恶意载荷位置 | | action | String | 防护动作 | | request_line | String | 请求方法和路径 | | headers | Object | http请求header | | cookie | String | 请求cookie | | status | String | 响应码状态 | | process_time | Integer | 处理时长 | | region | String | 地理位置 | | host_id | String | 域名id | | response_time | Long | 响应时长 | | response_size | Integer | 响应体大小 | | response_body | String | 响应体 | | request_body | String | 请求体 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表7IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表9IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表11IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | #### 请求示例 查询今天项目id为project_id的防护事件列表 ``` GET https://{Endpoint}/v1/{project_id}/waf/event?enterprise_project_id=0&page=1&pagesize=10&recent=today ``` #### 响应示例 **状态码：200** ``` { "total" : 1, "items" : [ { "id" : "04-0000-0000-0000-21120220421152601-2f7a5ceb", "time" : 1650525961000, "policyid" : "25f1d179896e4e3d87ceac0598f48d00", "host" : "x.x.x.x:xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "url" : "/osclass/oc-admin/index.php", "attack" : "lfi", "rule" : "040002", "payload" : " file=../../../../../../../../../../etc/passwd", "payload_location" : "params", "sip" : "x.x.x.x", "action" : "block", "request_line" : "GET /osclass/oc-admin/index.php?page=appearance&action=render&file=../../../../../../../../../../etc/passwd", "headers" : { "accept-language" : "en", "ls-id" : "xxxxx-xxxxx-xxxx-xxxx-9c302cb7c54a", "host" : "x.x.x.x", "lb-id" : "2f5f15ce-08f4-4df0-9899-ec0cc1fcdc52", "accept-encoding" : "gzip", "accept" : "*/*", "user-agent" : "Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.2309.372 Safari/537.36" }, "cookie" : "HWWAFSESID=2a1d773f9199d40a53; HWWAFSESTIME=1650525961805", "status" : "418", "host_id" : "6fbe595e7b874dbbb1505da3e8579b54", "response_time" : 0, "response_size" : 3318, "response_body" : "", "process_time" : 2, "request_body" : "{}", "region" : "BJ" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; public class ListEventSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("")) .build(); ListEventRequest request = new ListEventRequest(); try { ListEventResponse response = client.listEvent(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("")) \ .build() try: request = ListEventRequest() response = client.list_event(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.ListEventRequest{} response, err := client.ListEvent(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WAF/sdk?api=ListEvent)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | | 400 | 请求失败 | | 401 | token权限不足 | | 500 | 服务器内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。