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

获取访问数据的统计排名

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

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

我的收藏

API 说明

API 描述：基于加速域名收到的请求、指定的统计时间段和时间粒度，对每个指定的加速域名统计指定指标的汇总数据。汇总数据是按指定的数据维度进行分组统计并排序的。该 API 支持使用用户请求的特征作为数据维度。您最多能查询过去 92 天的数据。

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

说明

如果您是刚开始使用数据统计的 API，请务必先阅读以下文档，可以帮助您了解该 API 文档中的描述。

使用限制

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

请求说明

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

请求参数

Query

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

Body

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

表示一个数据维度。Metric 按这个维度进行数据统计并排序。该参数有以下取值：

  • location：表示用户请求来自的国家和地区。
  • province：表示用户请求来自的中国省级行政区。
  • isp：表示用户请求使用的中国网络运营商。
当 Item 是 province 或 isp 时，来自中国以外的国家和地区的请求不会被统计。
location
Metric
String
是

表示一个统计指标。该参数有以下取值：

  • traffic：表示内容分发网络响应用户请求所消耗的流量，单位是 Byte。
  • bandwidth：表示内容分发网络响应用户请求所消耗的带宽，单位是 bps。
  • requests：表示内容分发网络收到的用户请求数量。
关于每个指标的详情以及统计方式，参见 指标的定义以及统计方式。
traffic
StartTime
Long
是
表示统计时间段的开始时间，格式是 Unix 时间戳，精度是秒。StartTime 必须早于或者等于 EndTime。同时，StartTime 和 EndTime 所表示的统计时间段不能超过 31 天。
1710259200
EndTime
Long
是
表示统计时间段的结束时间，格式是 Unix 时间戳，精度是秒。
1710836303
Interval
String
否

表示指标数据的统计时间粒度。该 API 会基于 Interval 将 StartTime 和 EndTime 所表示的统计时间段拆分成一系列的时间区间，然后对每个时间区间统计 Metric 数据，最后统计这些 Metric 数据的汇总数据。

关于该参数对统计结果影响的详细描述，参考 统计时间段说明。

该参数有以下取值：

  • 1min：表示时间粒度是 1 分钟。
  • 5min：表示时间粒度是 5 分钟。

您可以指定的时间粒度受 StartTime 和 EndTime 所表示的时间范围的影响。

  • 如果时间范围 <= 1 天，您可以指定的时间粒度有 1min、5min。
  • 如果 1 天 < 时间范围 <= 31 天，您可以指定的时间粒度只能是 5min。
该参数的默认值是 5min。如果默认值不匹配时间范围，API 请求会失败。
5min
Project
String
否

表示一个项目，以获取该项目下的所有加速域名，用于对用户请求进行过滤。

如果不指定该参数，表示不使用该参数对请求进行过滤。
my_project
Domain
String
否

表示一个或多个加速域名，用于对用户请求进行过滤。您最多可以指定 50 个加速域名。多个域名之间使用逗号（,）分隔。如果您不指定 Domain，表示不使用该参数对请求进行过滤。

如果您指定了 Project，您可以指定的加速域名必须是归属于 Project 所指定项目。

说明

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

  • 子用户只能指定其有权限访问的加速域名。子用户可以调用 ListCdnDomains 查看其有权限访问的加速域名。
  • 如果不指定该参数，表示所有该子用户有权限访问的那些加速域名。
www.example.com,www.test.com,img.example.com

返回参数

参数名称
数据类型
参数说明
示例
Item
String
表示请求参数 Item 所指定的数据维度。
location
TopDataDetails
Object[]
表示该 API 返回的结果。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeDistrictRanking&Version=2021-03-01
{
    "StartTime": 1710259200,
    "EndTime": 1710835599,
    "Interval": "5min",
    "Metric": "traffic",
    "Item": "location",
    "Project": "my_project",
    "Domain": "www.example.com,www.test.com,img.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240319215130859B9D181422FB6F0ADE",
        "Action": "DescribeDistrictRanking",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Item": "location",
        "TopDataDetails": [
            {
                "Metric": "traffic",
                "ValueDetails": [
                    {
                        "ItemKey": "CHN",
                        "Ratio": 0.9527,
                        "Timestamp": 0,
                        "Value": 95270
                    },
                    {
                        "ItemKey": "USA",
                        "Ratio": 0.0472,
                        "Timestamp": 0,
                        "Value": 4720
                    },
                    {
                        "ItemKey": "OTHERS",
                        "Ratio": 0.0001,
                        "Timestamp": 0,
                        "Value": 10
                    }
                ]
            }
        ]
    }
}