You need to enable JavaScript to run this app.
导航
获取计费指标的细分数据(旧版)
最近更新时间:2024.06.18 21:01:46首次发布时间:2022.01.13 16:45:51

根据对应的计费数据指标,查询账号或是域名的计费明细数据。支持查询流量、带宽、请求数。CDN 在进行流量、带宽计费时,采用 5 分钟粒度明细数据进行计算。

说明

我们重新设计了该 API。新版 API 是 DescribeBillingDetail

使用限制

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

时间限制:域名计费数据保存近 365 天数据,不支持 365 天以前计费数据查询。

时间查询区间:一个请求的时间查询区间最长为 31 天。

数据延迟:计费数据的延迟约为 5 分钟。

数据稳定性:受边缘节点网络波动的影响,计费数据一般在第二天 9:00 左右稳定下来。请以火山引擎平台出具的账单数据为准,本接口查询结果仅供参考。

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
StartTime
Long

基于 StartTime 和 EndTime 获取统计明细数据。StartTime 以 5 分钟粒度向前取整,作为第一个返回的时间点,EndTime 以 5 分钟粒度向前取整,作为最后一个返回的时间点。

例子:StartTime:12:14,Endtime:12:22。返回的数据点为 12:10,12:15,12:20。对应统计区间分别为 [12:10, 12:15),[12:15, 12:20),[12:20, 12:25)

说明

为了描述简单,例子中的 StartTime 和 EndTime 简写为时间了,实际传入的应该是时间戳。

1641844915
Metric
String

指定一个指标,该参数的取值如下:

  • flux:表示访问流量的统计,单位是 Byte
  • bandwidth:表示访问带宽的统计,单位是 bps
  • pv: 表示访问请求数的统计。单位是
flux
EndTime
Long
查询结束时间
1641845373
Aggregate
String

指定是否汇总所有加速域名的指标。该参数适用于指定多个多加速域名进行统计的场景。该参数的可用值如下:

  • aggregate:汇总所有加速域名的指标。
  • disaggregate:不汇总加速域名的指标。

如果不指定 Domain 参数,表示查询账号下所有加速域名汇总计费的明细数据。此时系统强制设置 Aggregate 参数值为 aggregate。 如果指定 Domain 参数。此时:

  • 该参数的默认值是 disaggregate
  • 如果设置 Aggregate 参数值为 disaggregate,表示查询每一个加速域名的计费明细数据。
  • 如果设置 Aggregate 参数值为 aggregate,表示查询账号下所有加速域名汇总计费的明细数据。
aggregate
BillingRegion
String

指定一个计费区,对来自该计费区的请求进行统计。该参数的取值如下:

  • CHN:表示中国内地。
  • EU:表示欧洲区。
  • NA:表示北美区。
  • SA:表示南美区。
  • ME 或者 MEA:表示中东区和非洲区。
  • AP1:表示亚太一区。
  • AP2:表示亚太二区。
  • AP3:表示亚太三区。
该参数的默认值是 CHN
CHN
Domain
String
指定最多 50 加速域名,查询每一个加速域名的计费明细数据。多个加速域名使用逗号(,)分隔。 如果不指定该参数,表示查询账号下所有加速域名汇总计费的明细数据。
www.example.com,www.example2.com
Protocol
String

指定一种应用层协议,对使用该协议的请求进行统计。该参数的取值如下:

  • http:表示 HTTP 协议。
  • https:表示 HTTPS 协议。
  • quic:表示 QUIC 协议。
如果不指定该参数,表示所有支持的应用层协议。
http

响应正文

参数名称
数据类型
参数说明
示例
Resources
Object[]
计费数据明细

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeAccountingData&Version=2021-03-01
{
  "StartTime": 1690885328,
  "EndTime": 1690886228,
  "Domain": "www.example.com,www.test.com",
  "Metric": "flux"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230814181029481477279ABFBA808919",
    "Action": "DescribeAccountingData",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "Resources": [
      {
        "BillingRegion": "total",
        "Metrics": [
          {
            "Metric": "flux",
            "Values": [
              {
                "TimeStamp": 1690885200,
                "Value": 0
              },
              {
                "TimeStamp": 1690885500,
                "Value": 0
              },
              {
                "TimeStamp": 1690885800,
                "Value": 4494
              },
              {
                "TimeStamp": 1690886100,
                "Value": 0
              }
            ]
          }
        ],
        "Name": "www.example.com"
      },
      {
        "BillingRegion": "total",
        "Metrics": [
          {
            "Metric": "flux",
            "Values": [
              {
                "TimeStamp": 1690885200,
                "Value": 154793
              },
              {
                "TimeStamp": 1690885500,
                "Value": 155830
              },
              {
                "TimeStamp": 1690885800,
                "Value": 175992
              },
              {
                "TimeStamp": 1690886100,
                "Value": 155332
              }
            ]
          }
        ],
        "Name": "www.test.com"
      }
    ]
  }
}

错误码

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