最近更新时间:2023.12.14 15:48:05
首次发布时间:2022.03.23 11:21:52
API 名称:DescribeOriginTopNrtData
。
API 域名:cdn.volcengineapi.com
。
API 描述:基于指定的时间段,对一个或多个域名统计回源请求指标的数据并排序。该 API 支持的指标排序依据如下:
数据稳定性:受边缘节点网络波动的影响,监控数据的统计可能会发生变化。大多数情况下,监控数据的统计会在数据产生后的 12 小时内稳定下来。
说明
带宽峰值的计算方法如下:
节流限制:您每秒最多可以发送 20 个 API 请求。
时间限制:系统保留最近 92 天的访问数据。您不能查询 92 天以前的访问数据。
数据延迟:访问数据延迟约为 5 分钟 。
在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:
参数名称 | 数据类型 | 必选 | 参数说明 |
---|---|---|---|
Action | string | 是 | 表示 API 的名称。该参数的取值是 DescribeOriginTopNrtData 。 |
Version | string | 是 | 表示 API 的版本。该参数的取值是 2021-03-01 。 |
每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权。
在您调用该 API 时,请求正文中可以包含的参数如下。
参数名称 | 数据类型 | 必选 | 参数说明 | 示例 |
---|---|---|---|---|
StartTime | int64 | 否 | 指定一个开始时间。时间格式是 Unix 时间戳,精度是秒。 StartTime 必须早于或者等于 EndTime 。您必须同时指定 StartTime 和 EndTime ,或者都不指定。如果您不指定这 2 个参数,默认统计最近 24 小时的数据。 | 1641844915 |
EndTime | int64 | 否 | 指定一个结束时间。时间格式是 Unix 时间戳,精度是秒。 | 1641845373 |
Interval | string | 否 | 指定一个时间粒度。基于这个粒度,对访问请求指标的数据进行统计并排序。该参数仅对 bandwidth 指标有效。该参数的可用值如下:
5min 。带宽的统计步骤如下:
| |
Domain | string | 否 | 指定一个或者多个加速域名,最多 50 个。基于 Metric 中指定的指标,对这些加速域名进行排序。多个加速域名使用逗号 (,) 分隔。逗号后面不能加空格。如果不指定该参数,则包含账号下的所有域名。 子账号调用说明: 如果是子账号调用该 API,需要注意以下几点:
| www.example.com |
Item | string | 是 | 指定一个排序维度。该参数的可用值是如下:
| domain |
Metric | string | 是 | 指定一个指标作为排序依据。 排序是按照数据从大到小排列的。该参数的可用值如下:
| flux |
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
Item | string | 表示统计的排序维度。 | domain |
Metric | string | 表示统计的指标。包含所有指标。 | flux |
Name | string | 表示指定统计的所有域名,未指定域名时为空,展示全部域名的回源数据,若域名无回源时,则不展示对应域名的数据 | www.a.com,www.b.com |
TopDataDetails | TopDataDetails[] | 表示一个或多个的统计数据对象。按指标数据从大到小排序。无域名回源数据时,用 null 表示 | "TopDataDetails": null |
POST https://cdn.volcengineapi.com?Version=2021-03-01&Action=DescribeOriginTopNrtData { "StartTime": 1647774669, "EndTime": 1647963291, "Metric": "flux", "Domain":"www.example.com,www.example2.com", "Item":"domain" }
{ "ResponseMetadata": { "RequestId": "20220105181801010211175223230002B9", "Action": "DescribeOriginTopNrtData", "Version": "2021-03-01", "Service": "CDN", "Region": "cn-north-1" }, "Result": { "Item": "domain", "Metric": "Flux", "Name": "www.example.com,www.example2.com", "TopDataDetails": [ { "Bandwidth": 33931.5093, "BandwidthPeakTime": 1647880500, "Flux": 1279818, "FluxRatio": 0.9480421257238183, "ItemKey": "www.example.com", "PV": 27, "PVRatio": 0.12735849056603774 }, { "Bandwidth": 62.3627, "BandwidthPeakTime": 1647800400, "Flux": 13904, "FluxRatio": 0.01029957206107741, "ItemKey": "www.example2.com", "PV": 31, "PVRatio": 0.14622641509433962 }, ] } }
如果响应正文包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见 错误码。