全部产品
Search
文档中心

边缘安全加速:DescribeDcdnWafUsageData - 查询WAF用量数据

更新时间:Oct 17, 2024

调用DescribeDcdnWafUsageData查询WAF用量数据。

接口说明

说明
  • 单用户调用频率: 10 次/秒
  • 支持查询的最小时间粒度为 5 分钟;查询的最大时间跨度为 31 天;可查询最大历史数据时间范围为 90 天。
  • 调试

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

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    DomainNamestring

    查询域名。若参数为空,默认返回所有加速域名。

    example.com
    StartTimestring

    获取数据起始时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

    2018-09-30T16:00:00Z
    EndTimestring

    获取数据结束时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

    说明 结束时间需大于起始时间。
    2018-10-01T16:00:00Z
    Intervalstring

    查询数据的时间粒度,单位为秒。

    根据单次查询的最大时间跨度不同,该参数支持 300(5 分钟)、3600(1 小时)和 86400(1 天)取值。

    300
    SplitBystring

    查询结果分组方式。取值:

    • domain:按加速域名分组。

    • 参数为空(默认):查询结果不分组。

    domain

    返回参数

    名称类型描述示例值
    object
    EndTimestring

    结束时间。

    2018-10-01T16:00:00Z
    StartTimestring

    开始时间。

    2018-09-30T16:00:00Z
    RequestIdstring

    请求 ID。

    CB1A380B-09F0-41BB-802B-72F8FD6DA2FE
    WafUsageDataarray<object>

    加速域名使用 WAF 信息。

    WafUsageDataItemobject
    ObserveCntlong

    观察的请求数。

    300
    Domainstring

    加速域名。

    example.com
    BlockCntlong

    拦截的请求数。

    300
    AccessCntlong

    正常访问的请求数。

    600
    TimeStampstring

    时间片起始时刻。

    2018-09-30T16:00:00Z
    SecCulong

    产生的 SeCU 计量单元数。

    50

    示例

    正常返回示例

    JSON格式

    {
      "EndTime": "2018-10-01T16:00:00Z",
      "StartTime": "2018-09-30T16:00:00Z",
      "RequestId": "CB1A380B-09F0-41BB-802B-72F8FD6DA2FE",
      "WafUsageData": {
        "WafUsageDataItem": [
          {
            "ObserveCnt": 300,
            "Domain": "example.com",
            "BlockCnt": 300,
            "AccessCnt": 600,
            "TimeStamp": "2018-09-30T16:00:00Z",
            "SecCu": 50
          }
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400MissingTimeParameterThe StartTime and EndTime must be both specified.请同时提供开始时间和结束时间。
    400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.请提供正确的开始时间格式。日期格式按照ISO8601表示法,并使用UTC时间,格式为:yyyy-MM-ddTHH:mm:ssZ。
    400InvalidEndTime.MalformedThe specified EndTime is invalid.请提供正确的结束时间格式。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:yyyy-MM-ddTHH:mm:ssZ。
    400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.开始时间或结束时间格式错误。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。
    400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查。
    400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
    400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.不支持该开始时间,请重新填写。

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