You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

获取带宽流量

最近更新时间：2024.03.15 17:14:57

首次发布时间：2022.06.27 09:59:25

我的收藏

此接口通过域名等条件，获取带宽流量数据。

使用说明

  • 如果您不指定 StartTimestamp 和 EndTimestamp，此接口返回当天（0:00-24:00）的数据。
  • 如果您指定了 StartTimestamp 和 EndTimestamp，此接口返回指定时间段的数据。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 数据延迟：访问数据的延迟约为 5 分钟。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListCdnUsageData&Version=2022-12-01

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数类型是否必选示例值描述
ActionString是ListCdnUsageData接口名称。当前 API 的名称为 ListCdnUsageData。
VersionString是2022-12-01接口版本。当前 API 的版本为 2022-12-01。
DomainsString是example.vod.com域名，多个用英文 , 逗号隔开。您可通过 ListDomain 接口获取指定空间下的域名列表。

Interval

String

是

auto

指定查询数据的时间粒度。取值如下：

  • auto：自动聚合。
  • 5min：5 分钟粒度。
  • hour：1 小时粒度。
  • day：天粒度。

StartTimestamp

Integer

否

1687276800

查询范围起始时间。Unix 时间戳，单位为秒。它表示从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的秒数。默认当天 0 点。

说明

JSON 中为 String 类型。

EndTimestamp

Integer

否

1687967999

查询范围截止时间。Unix 时间戳，单位为秒。它表示从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的秒数。默认为第二天 0 点。

说明

  • 最大支持单次查询 90 天的数据。
  • JSON 中为 String 类型。

DataType

String

是

edge

统计数据类别。取值如下：

  • edge：边缘数据统计。
  • origin：回源数据统计。

Metric

String

是

bandwidth

指标类别。取值如下：

  • bandwidth：带宽视角。
  • flux：流量视角。

NeedDetail

Boolean

否

true

是否需要返回分域名的详细数据。 取值如下：

  • false：否。
  • true：是。

Area

String

否

China

访问区域。取值如下：

  • China：中国内地。
  • Global：全球。

说明

当 DataType 参数取值为 edge 时，该 Area 参数才有效。

Region

String

否

BJ

国家或地区代码。统计 IP 归属地为该区域的访问细分数据。您可通过调用 DescribeCdnRegionAndIsp 获取国家，地区和省份代码。默认为所有数据，多个国家或者地区用 , 隔开。

说明

当 DataType 参数取值为 edge 时，该 Region 参数才有效。

Isp

String

否

CT

用户运营商。您可通过调用 DescribeCdnRegionAndIsp 获取运营商数据。默认为所有数据，多个运营商用 , 隔开。

说明

当 DataType 参数取值为 edge 时，该 Isp 参数才有效。

Protocol

String

否

https

应用协议。取值如下：

  • http：HTTP。
  • https：HTTPS。
  • quic：QUIC。

说明

  • 当 DataType 参数取值为 edge 时，该 Protocol 参数才有效。
  • 不支持设置多个取值，默认不填充时为所有。

IpVersion

String

否

ipv4

网络层协议。取值如下：

  • ipv4：IPv4。
  • ipv6：IPv6。

说明

  • 当 DataType 参数取值为 edge 时，该 IpVersion 参数才有效。
  • 不支持设置多个取值，默认不填充时为所有。

BillingRegion

String

否

CHN

计费区域。默认为空值。此参数为空时，会返回所有计费区域的汇总数据。取值如下：

  • CHN：中国内地
  • EU：欧洲区
  • NA：北美区
  • SA：南美区
  • MEA：中东区和非洲区
  • AP1：亚太一区
  • AP2：亚太二区
  • AP3：亚太三区
  • All：对每个计费区域分别统计访问数据

说明

各计费区包含的国家和地区详见计费区说明。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数类型示例值描述
DatasArray of Datas-数据列表
NoPermissionDomainsArray of String-无权限域名列表

Datas

参数类型示例值描述
NameStringtotal统计目标名
MetricStringbandwidth指标类别
DataTypeStringedge统计类别
RegionStringBJ国家或地区代码
IspStringCT用户运营商
BillingRegionStringCHN计费区域
PointsArray of Points-打点数据

Points

参数类型示例值描述
TimestampDouble1653494400时间戳。

Value

Double

458700098.3547

数值。

说明

该参数可能不存在，当不存在时则默认返回 0。

请求示例

https://vod.volcengineapi.com?Action=ListCdnUsageData&Version=2022-12-01&Domains=&Interval=&StartTimestamp=1687276800&EndTimestamp=1687967999&DataType=&Metric=&NeedDetail=&Area=&Region=&Isp=&Protocol=&IpVersion=&BillingRegion=

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202205261531390***05620412B5A92D",
    "Action": "ListCdnUsageData",
    "Version": "2022-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Datas": [
      {
        "Name": "total",
        "Metric": "bandwidth",
        "DataType": "origin",
        "Points": [
          {
            "Timestamp": 1653494400,
            "Value": 458700098.3547
          }
        ]
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：