You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

获取热门对象的统计排名

最近更新时间：2024.04.18 16:04:09

首次发布时间：2024.04.16 14:36:31

我的收藏

API 说明

API 描述：基于指定的统计时间段和指标，获取一个指定加速域名的那些热门对象。热门对象是基于指标的汇总数据而排序的。您最多能查询过去 92 天的数据。

数据稳定性：受边缘节点网络波动的影响，监控数据的统计可能会发生变化。大多数情况下，监控数据的统计会在数据产生后的 12 小时内稳定下来。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

  • 请求方式：POST
  • 请求地址：https://cdn.volcengineapi.com/?Action=DescribeStatisticalRanking&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
是
接口名称。当前 API 的名称为 DescribeStatisticalRanking。
Version
String
是
接口版本。当前 API 的版本为 2021-03-01。

Body

参数名称
数据类型
是否必选
参数说明
示例
Item
String
是

表示热门对象的类型。该参数有以下取值：

  • region：表示发送用户请求的客户端所在的国家或地区。
  • url：表示请求的 URL。
  • referer：表示请求中的 Referer 头部。
  • ua：表示请求中的 User-Agent 头部。
  • clientip：表示客户端的 IP 地址。

说明

  • 当 Item 是 ua 时，您还需要指定 UaType。
  • 当 Item 是 region 时，您还需要指定 Area。
region
Metric
String
是

表示一个统计指标。内容分发网络基于 Metric 的汇总数据统计热门的 Item 对象并排序。该参数的可用值受 Item 的影响。

  • 当 Item 是 referer、ua 或 clientip 时，该参数的可用值如下：
    • traffic：表示内容分发网络响应用户请求所消耗的流量，单位是 Byte。
    • requests：表示内容分发网络收到的用户请求数量。
  • 当 Item 是 url 时，该参数的可用值如下：
    • traffic
    • requests
    • status_2xx：在内容分发网络对用户请求的响应中，该参数表示数字 2 开头的响应状态码数量。
    • status_3xx：表示数字 3 开头的响应状态码数量。
    • status_4xx：表示数字 4 开头的响应状态码数量。
    • status_5xx：表示数字 5 开头的响应状态码数量。
  • 当 Item 是 region 时，该参数的可用值如下：
    • clientip：表示客户端 IP 地址的请求数。
traffic
StartTime
Long
是

表示统计时间段的开始时间，格式是 Unix 时间戳，精度是秒。StartTime 必须早于或者等于 EndTime。同时，StartTime 和 EndTime 所表示的统计时间段不能超过 31 天。

说明

StarTime 和 EndTime 指定了统计时间段。但是，内容分发网络在统计数据指标数据时，实际使用的统计时间段是在小时级别取整的。

例子：StarTime 表示的时间是 15:07，EndTime 表示的时间是 15:21，那么实际的统计时间段是 [15:00,16:00）。

需要留意的是，如果 EndTime 正好是整点，那么实际的统计时间段还要再往后延长 1 小时。假设 StartTime 表示的时间是 15:07，EndTime 表示的时间是 16:00，那么实际的统计时间段是 [15:00,17:00)。

1710950400
EndTime
Long
是
表示统计时间段的结束时间，格式是 Unix 时间戳，精度是秒。
1710998170
Domain
String
是

表示一个加速域名，用于对用户请求进行过滤。

说明

当子用户调用该 API 时，请留意以下说明：

  • 子用户只能指定其有权限访问的加速域名。子用户可以调用 ListCdnDomains 查看其有权限访问的加速域名。
UaType
String
否

表示 User-Agent 头部值中包含的对象的类型。当 Item 是 ua 时，该参数必填。当 Item 不是 ua 时，该参数无效。该参数有以下取值：

  • browser：表示 User-Agent 头部值中包含的浏览器类型。
  • system：表示 User-Agent 头部值中包含的操作系统名称。
  • equipment：表示 User-Agent 头部值中包含的客户端设备类型。
system
Area
String
否

表示一个地域粒度，内容分发网络按这个粒度对 Metric 进行分组统计并排序。当 Item 为 region 时，该参数必填。当 Item 不是 region 时，该参数无效。该参数有以下取值：

  • Global：表示 Metric 是按国家和地区而分组统计并排序的。
  • China：表示 Metric 是按中国省级行政区而分组统计并排序的。
global

返回参数

参数名称
数据类型
参数说明
示例
Item
String
表示请求参数 Item 所指定的热门对象的类型。
region
Metric
String
表示请求参数 Metric 所指定的指标。
traffic
RankingDataList
Object[]
表示该 API 返回的热门对象的列表。列表中最多包含 1,000 个对象。
UaType
String
表示请求参数中 UaType 所指定的对象类型。如果请求参数中不包含 UaType，该参数不会在返回结果中出现。
system

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeStatisticalRanking&Version=2021-03-01
{
    "Area": "China",
    "Domain": "www.example.com",
    "StartTime": 1710950400,
    "EndTime": 1710998170,
    "Item": "region",
    "Metric": "traffic"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202403212143118BE5C18DF185F3E6169A",
        "Action": "DescribeStatisticalRanking",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Item": "region",
        "Metric": "traffic",
        "RankingDataList": [
            {
                "ItemKey": "GS",
                "ItemKeyCN": "甘肃",
                "Value": 777
            },
            {
                "ItemKey": "ZJ",
                "ItemKeyCN": "浙江",
                "Value": 348
            },
            {
                "ItemKey": "NM",
                "ItemKeyCN": "内蒙古",
                "Value": 271
            },
            {
                "ItemKey": "NX",
                "ItemKeyCN": "宁夏",
                "Value": 83
            },
            {
                "ItemKey": "CQ",
                "ItemKeyCN": "重庆",
                "Value": 78
            },
            {
                "ItemKey": "OTHERS",
                "ItemKeyCN": "OTHERS",
                "Value": 39
            },
            {
                "ItemKey": "SH",
                "ItemKeyCN": "上海",
                "Value": 36
            },
            {
                "ItemKey": "XZ",
                "ItemKeyCN": "西藏",
                "Value": 19
            },
            {
                "ItemKey": "MO",
                "ItemKeyCN": "澳门",
                "Value": 2
            },
            {
                "ItemKey": "TW",
                "ItemKeyCN": "台湾",
                "Value": 2
            }
        ]
    }
}