全部产品
Search

搜索本产品

    Web 应用防火墙：DescribeApisecEvents - 查询API安全事件列表

    文档中心

    Web 应用防火墙：DescribeApisecEvents - 查询API安全事件列表

    更新时间：Nov 15, 2024

    查询API安全事件列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-waf:DescribeApisecEventsget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    WAF 实例的 ID。

    说明 您可以调用 DescribeInstance 获取当前 WAF 实例的 ID。
    		waf_v2_public_cn-5y***d31
    EventIdstring否

    API 安全事件 ID。

    		18ba94fea9***e66ba0557b7b91
    ApiFormatstring否

    API 接口。

    		/apisec/v1/***.php
    MatchedHoststring否

    API 接口所属的域名或 IP。

    		a.***.com
    EventTagstring否

    事件类型。

    说明 您可以调用 DescribeApisecRules 获取支持的事件类型。
    		ObtainSensitiveUnauthorized
    StartTslong否

    查询的开始时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

    		1683648000
    EndTslong否

    查询的结束时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

    		1683703260
    OrderKeystring否

    排序字段的名称。取值：

    • allCnt：表示攻击次数。
    • startTs：表示事件开始时间。
    • endTs：表示事件结束时间。
    		startTs
    OrderWaystring否

    排序的方式。取值：

    • desc：表示降序（默认）。
    • asc：表示升序。
    		desc
    PageNumberlong否

    分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。

    		1
    PageSizelong否

    分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。

    		10
    ApiTagstring否

    API 业务用途。

    说明 您可以调用 DescribeApisecRules 获取支持的业务用途。
    		SendMail
    Originstring否

    事件类型的来源。取值：

    • custom：表示自定义。
    • default：表示内置。
    		default
    EventLevelstring否

    事件等级。取值：

    • high：表示高危。
    • medium：表示中危。
    • low：表示低危。
    		low
    UserStatusstring否

    事件状态。取值：

    • toBeConfirmed：表示待确认。
    • confirmed：表示已确认。
    • ignored：表示忽略。
    		ignored
    AttackIpstring否

    攻击 IP。

    		42.224.*.*
    ApiIdstring否

    API 的 ID。

    		820b860***6205da93b935b28
    ClusterIdstring否

    混合云集群 ID。

    说明 只针对混合云场景，您可以调用 DescribeHybridCloudClusters 获取混合云集群信息。
    		428
    RegionIdstring否

    WAF 实例所属地域。取值：

    • cn-hangzhou：表示中国内地。

    • ap-southeast-1：表示非中国内地。

    		cn-hangzhou
    ResourceManagerResourceGroupIdstring否

    阿里云资源组 ID。

    		rg-acfm***q

    返回参数

    名称类型描述示例值
    object

    请求结果。

    TotalCountlong

    返回结果的总数。

    		3
    RequestIdstring

    请求 ID。

    		12F4CC8F-7E9F-5E4D-BF7C-BD1EDDE0C282
    Dataarray<object>

    安全事件列表。

    resourceobject

    安全事件信息。

    Originstring

    事件类型的来源。取值：

    • custom：表示自定义。
    • default：表示内置。
    		custom
    EventLevelstring

    事件等级。取值：

    • high：表示高危。
    • medium：表示中危。
    • low：表示低危。
    		medium
    StartTslong

    查询的开始时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

    		1683648000
    EventInfostring

    事件详细信息，以一系列参数构造的 JSON 格式转化成字符串。包括：

    • ip_info：表示攻击 IP 信息，可以参考本接口的返回参数 AttackIpInfo。
    • rule_id：表示事件对应的规则 ID。
    • rule_tag：表示事件对应的规则信息。
    		{ "ip_info": [ { "ip": "112.224.143.**", "country_id": "CN", "region_id": "-", "cnt": "4" } ], "rule_id": "837**", "rule_tag": "接口返回大量敏感信息" }
    ApiFormatstring

    API 接口。

    		/apisec/v1/register.php
    ApiTagstring

    API 业务用途。

    说明 您可以调用 DescribeApisecRules 获取支持的业务用途。
    		SendMail
    UserStatusstring

    事件状态。取值：

    • toBeConfirmed：表示待确认。
    • confirmed：表示已确认。
    • ignored：表示忽略。
    		toBeConfirmed
    Followinteger

    是否关注。取值：

    • 1：表示关注。
    • 0：表示未关注。
    		0
    RequestDatastring

    API 请求数据实例，以一系列参数构造的 JSON 格式转化成字符串。

    		{}
    EventIdstring

    事件 ID。

    		c82cb276847e9c96f9597d9f4b0cdcff
    AttackIpstring

    攻击 IP。

    		104.234.140.**
    AttackIpInfostring

    攻击 IP 相关信息，以一系列参数构造的 JSON 格式转化成字符串。包括：

    • ip：表示 IP 地址。
    • country_id：表示所属国家。
    • region_id：表示所属地区。
    • cnt：表示攻击次数。
    		[ { "ip": "72.*.*.119", "country_id": "US", "region_id": "", "cnt": "2100" } ]
    EndTslong

    查询的结束时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

    		1683703260
    AttackCntInfostring

    攻击数量相关信息，以一系列参数构造的 JSON 格式转化成字符串。其中 Key 为时间戳，单位为秒、Value 为攻击数量。

    		{ "1717498320": 500, "1717498380": 529, "1717498440": 20 }
    AllCntlong

    攻击次数。

    		10
    RemoteRegionstring

    攻击 IP 所属地区。

    		110000
    ResponseDatastring

    API 响应数据示例，以一系列参数构造的 JSON 格式转化成字符串。

    		{}
    AttackClientstring

    攻击客户端。

    		Chrome
    EventTagstring

    事件类型。

    说明 您可以调用 DescribeApisecRules 获取支持的事件类型。
    		ObtainSensitiveUnauthorized
    MatchedHoststring

    API 接口所属的域名或 IP。

    		a.***.com
    Notestring

    备注信息。

    		已通知
    ApiIdstring

    安全事件关联 API 的 ID。

    		2ecc1cf67b91853bc55545052ccf06a8
    RemoteCountrystring

    攻击 IP 所属国家。

    		US

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 3,
  "RequestId": "12F4CC8F-7E9F-5E4D-BF7C-BD1EDDE0C282",
  "Data": [
    {
      "Origin": "custom",
      "EventLevel": "medium",
      "StartTs": 1683648000,
      "EventInfo": "{\n    \"ip_info\": [\n        {\n            \"ip\": \"112.224.143.**\",\n            \"country_id\": \"CN\",\n            \"region_id\": \"-\",\n            \"cnt\": \"4\"\n        }\n    ],\n    \"rule_id\": \"837**\",\n    \"rule_tag\": \"接口返回大量敏感信息\"\n}\n",
      "ApiFormat": "/apisec/v1/register.php",
      "ApiTag": "SendMail",
      "UserStatus": "toBeConfirmed",
      "Follow": 0,
      "RequestData": "{}",
      "EventId": "c82cb276847e9c96f9597d9f4b0cdcff",
      "AttackIp": "104.234.140.**",
      "AttackIpInfo": "[\n    {\n        \"ip\": \"72.*.*.119\",\n        \"country_id\": \"US\",\n        \"region_id\": \"\",\n        \"cnt\": \"2100\"\n    }\n]",
      "EndTs": 1683703260,
      "AttackCntInfo": "{\n    \"1717498320\": 500,\n    \"1717498380\": 529,\n    \"1717498440\": 20\n}",
      "AllCnt": 10,
      "RemoteRegion": "110000",
      "ResponseData": "{}",
      "AttackClient": "Chrome",
      "EventTag": "ObtainSensitiveUnauthorized",
      "MatchedHost": "a.***.com",
      "Note": "已通知",
      "ApiId": "2ecc1cf67b91853bc55545052ccf06a8",
      "RemoteCountry": "US"
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。