DescribeEdgeTopNrtData - 获取访问数据的统计排名--内容分发网络-火山引擎

文档中心

内容分发网络

数据统计接口（旧版）

DescribeEdgeTopNrtData - 获取访问数据的统计排名

说明

我们全新设计了数据统计 API。推荐您使用以下新版 API：

API 说明

API 名称：DescribeEdgeTopNrtData。
API 域名：cdn.volcengineapi.com。
API 描述：基于指定的时间段，对一个或多个域名统计访问请求指标的数据并排序。该 API 支持的排序维度如下：

多域名汇总数据排名。最多可支持50个域名。
- 流量：基于域名的总流量从高到低排序。
- 请求数：基于域名的总请求数从高到低排序。
- 带宽：基于域名的带宽峰值排序。
区域排名。根据访客 IP 所在区域，进行统计排序。
- 流量：基于中国区各省份或全球各国家和地区的总流量从高到低排序。
- 请求数：基于中国区各省份或全球各国家和地区的总请求数从高到低排序。
- 带宽：基于中国区各省份或全球各国家和地区的带宽峰值从高到低排序。
运营商排名。根据访客 IP 所在运营商，进行统计排序。
- 流量：基于各运营商总流量从高到低排序。
- 请求数：基于各运营商总请求数从高到低排序。
- 带宽：基于各运营商峰值带宽从高到低排序。

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

说明

如果您是刚开始使用数据统计的 API，请务必先阅读以下文档，这将有助于您理解该 API 文档。

使用限制

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

时间限制：系统保留最近 92 天的访问数据。您不能查询 92 天以前的访问数据。

数据延迟：访问数据延迟约为 5 分钟。

公共参数

在调用该 API 时，您在请求中必须包含公共参数。在这些公共参数中，以下两个查询参数的取值说明如下：

参数名称	数据类型	必选	参数说明
Action	string	是	表示 API 的名称。该参数的取值是 `DescribeEdgeTopNrtData`。
Version	string	是	表示 API 的版本。该参数的取值是 `2021-03-01`。

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权。

请求正文参数

在您调用该 API 时，请求正文中可以包含的参数如下。

参数名称	数据类型	必选	参数说明	示例
StartTime	int64	否	指定一个开始时间。时间格式是 Unix 时间戳，精度是秒。`StartTime` 必须早于或者等于 `EndTime`。您必须同时指定 `StartTime` 和 `EndTime`，或者都不指定。如果您不指定这 2 个参数，默认统计最近 24 小时的数据。	`1641844915`
EndTime	int64	否	指定一个结束时间。时间格式是 Unix 时间戳，精度是秒。	`1641845373`
Interval	string	否	指定一个时间粒度。基于这个粒度，对访问数据的统计进行排序。该参数仅对 `bandwidth` 指标有效。该参数的可用值如下： `1min`：表示 `bandwidth` 这个指标以 1 分钟时间粒度进行统计并排序。 `5min`：表示 `bandwidth` 这个指标以 5 分钟时间粒度进行统计并排序。如果不指定该参数，该参数使用默认值 `5min`。	`5min`
Domain	string	否	指定一个或者多个加速域名，最多 50 个。基于 `Metric` 中指定的指标，对这些加速域名进行排序。多个加速域名使用逗号`（,）`分隔。逗号后面不能加空格。如果不指定该参数，则包含账号下的所有域名。子账号调用说明：如果是子账号调用该 API，需要注意以下几点：子账号指定了 Domain 参数。但是在指定的加速域名中存在该子账号无权限访问的域名。此时 API 调用会失败并且报`您没有权限执行该操作`错误。子账号未指定 Domain 参数。此时则包含该子账号有权限访问的所有域名。关于更多子账号权限信息，参考权限管理概述。	`www.example.com`
Item	string	是	指定一个排序维度。该参数的可用值是如下： `region`：统计访客 IP 归属区域的指标数据并排序。区域的范围可通过 Area 参数指定。 `domain`：统计各域名的指标数据并排序。 `isp`：统计运营商的指标数据并排序。	`isp`
Metric	string	是	指定一个指标作为排序依据。排序是按照数据从大到小排列的。该参数的可用值如下： `flux`：表示基于流量排序。 `banthwidth`：表示基于带宽峰值排序。 `pv`：表示基于请求数排序。	`flux`
Area	string	否	该指定一个访客 IP 归属的区域。当 `Item=region`时，该参数有效。该参数的可用值如下： `China`：表示中国区域。对中国各省份的指标数据进行排序。 `Global`：表示全球区域。对全球各国家和地区的指标数据进行排序。如果不指定该参数，该参数使用默认为 `China`。	`China`
BillingRegion	string	否	指定一个计费区域，统计指定计费区域的访问数据，计费区域是节点的 IP 归属的区域。默认的计费区域是中国内地。您可以提交工单启用中国内地以外的计费区域。该参数的可用值如下： `CHN`：表示中国内地。 `EU`：表示欧洲区。 `NA`：表示北美区。 `SA`：表示南美区。 `ME`：表示中东区和非洲区。该参数值在未来会被弃用。请使用 `MEA` 代替。 `MEA`：表示中东区和非洲区。 `AP1`：表示亚太一区。 `AP2`：表示亚太二区。 `AP3`：表示亚太三区。不指定该参数时，统计的是所有计费区域的汇总数据。	`CHN`

响应正文

参数名称	数据类型	参数说明	示例
Item	string	表示统计的排序维度。	`domain`
Metric	string	表示统计的指标。包含所有指标。	`flux`
Name	string	表示统计的所有域名。	`www.a.com,www.b.com`
TopDataDetails	TopDetail[]	表示一个或多个的统计数据对象。按指标数据从大到小排序。

示例

请求示例

POST https://cdn.volcengineapi.com?Version=2021-03-01&Action=DescribeEdgeTopNrtData
{
    "StartTime": 1641263400,
    "EndTime": 1641265200,
    "Metric": "flux",
    "Domain":"www.example.com,www.example2.com",
    "Item":"region",
    "Area":"china"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20220105181801010211175223230002B9",
        "Action": "DescribeEdgeTopNrtData",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "Item": "region",
        "Metric": "Flux",
        "Name": "www.example.com,www.example2.com",
        "TopDataDetails": [
            {
                "Bandwidth": 730.8693,
                "BandwidthPeakTime": 1641263400,
                "Flux": 101449,
                "FluxRatio": 1,
                "ItemKey": "GD",
                "ItemKeyCN": "广东",
                "PV": 296,
                "PVRatio": 1
            },
            {
                "Bandwidth": 0,
                "BandwidthPeakTime": 0,
                "Flux": 0,
                "FluxRatio": 0,
                "ItemKey": "BJ",
                "ItemKeyCN": "北京",
                "PV": 0,
                "PVRatio": 0
            },
            .....
            {
                "Bandwidth": 0,
                "BandwidthPeakTime": 0,
                "Flux": 0,
                "FluxRatio": 0,
                "ItemKey": "AH",
                "ItemKeyCN": "安徽",
                "PV": 0,
                "PVRatio": 0
            }
        ]
    }
}

错误代码

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

最近更新时间：2025.12.01 14:38:50

这个页面对您有帮助吗？

有用

无用

内容分发网络

API 说明 #

使用限制 #

公共参数 #

请求鉴权 #

请求正文参数 #

响应正文 #

示例 #

请求示例 #

响应示例 #

错误代码 #