API 说明

基于火山引擎内容分发网络（CDN）收到的用户请求，该 API 按分组对一系列的指标数据进行汇总，并对这些汇总数据按从大到小排序。分组条件包括加速域名和计费区域。

要调用该 API，您需要指定一个指标，一个分组条件，一个统计时间段和一个时间粒度。您还可以指定多个过滤条件（包括计费区域）对用户请求进行过滤。您最多能查询过去 92 天的数据。

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

数据时效性：指标数据可能会有 5 分钟左右的延时。

使用限制

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

请求说明

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

请求参数

Query

Body

项目数据是如何统计的

在对一个项目统计指标数据时，CDN 统计的是项目内加速域名的数据。

• 如果统计时间段内有一个加速域名转出该项目，该项目的指标数据不会包含转出后该加速域名的数据。
• 如果统计时间段内有一个加速域名转入该项目，该项目的指标数据会包含转入后该加速域名的数据。

示例

考虑以下场景：

• 您指定的统计时间段是某天的 8:00-10:00。
• 加速域名X 在 9:00 从另一个项目转移到项目A。加速域名Y 一直在项目A 中。

在这个场景中，如果您对项目A 统计指标数据，则指标数据涵盖：

• 加速域名X 在 9:00 至 10:00 之间的指标数据。
• 加速域名Y 在 8:00 至 10:00 之间的指标数据。

Item、Project、Domain 的配置组合

返回参数

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240319213805B26C2E037A32BD07A1EE",
        "Action": "DescribeEdgeRanking",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "Item": "domain",
        "TopDataDetails": [
            {
                "Metric": "traffic",
                "ValueDetails": [
                    {
                        "ItemKey": "www.example.com",
                        "Ratio": 0.015,
                        "Timestamp": 0,
                        "Value": 4176250544
                    },
                    {
                        "ItemKey": "www.test.com",
                        "Ratio": 0.8414,
                        "Timestamp": 0,
                        "Value": 233555633476
                    },
                    {
                        "ItemKey": "img.example.com",
                        "Ratio": 0.0229,
                        "Timestamp": 0,
                        "Value": 6226604238
                    }
                ]
            }
        ]
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。