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

基于火山引擎内容分发网络(CDN)收到的用户请求,该 API 对一个计费指标统计一系列细分数据。

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

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

说明

使用限制

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

请求说明

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

请求参数

Query

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

Body

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

表示统计时间段的开始时间,格式是 Unix 时间戳,精度是秒。

  • StartTime 必须早于或者等于 EndTime
  • StartTime 与 EndTime 所表示的统计时间段不能超过 31 天。
  • StartTime 不能早于 2023年9月1日。
1717222134
EndTime
Long
表示统计时间段的结束时间,格式是 Unix 时间戳,精度是秒。
1717567734
Interval
String

表示一个时间粒度。该 API 基于 IntervalStartTimeEndTime 所表示的统计时间段拆分成一系列的时间区间,然后对每个时间区间统计 Metric 数据。

关于 Interval参数是如何用来拆分统计时间段,参考 统计时间段说明

该参数有以下取值:

  • 5min:表示时间粒度是 5 分钟。
  • hour:表示时间粒度是 1 小时。
  • day:表示时间粒度是 1 天。

该参数的默认值是 5min

说明

账单数据是基于 5 分钟粒度而统计的。因此,如果您在调用该 API 时指定 Interval5min,您获取的是账单数据的细分。基于 hourday 的细分数据是供您参考的。

day
Project
String

表示一个项目,用于统计项目级别的指标数据。如果不指定 Project,表示统计的是加速域名级别的指标数据。

示例
考虑以下场景:

  • 您指定的统计时间段是某天的 8:00-10:00。

  • 加速域名X 在 9:00 从另一个项目转移到项目A。加速域名Y 一直在项目A 中。

在这个场景中,

  • 假设您既指定了项目A,又指定了加速域名X 与加速域名Y。在这个情况下,您获取的是项目级别的指标数据,涵盖:

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

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

  • 假设您未指定项目A,但是指定了加速域名X 与加速域名Y。在这个情况下,您获取的是加速域名级别的指标数据,涵盖:

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

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

default
Domain
String

表示一个或多个加速域名,用于对用户请求进行过滤。您最多可以指定 50 个加速域名。多个域名之间使用逗号(,)分隔。如果不指定 Domain,表示不使用该参数对请求进行过滤。

需要留意的是:

  • 如果指定了 Project,您获取的是指定加速域名在项目级别的指标数据。也就是说,如果这些加速域名在统计时间段内转入或者转出该项目,指标数据会受到影响。

  • 如果未指定 Project,您获取的是指定加速域名在加速域名级别的指标数据。也就是说,如果这些加速域名在统计时间段内转入或者转出任何项目,指标数据不会受到影响。

参见 Project 描述中的示例。

说明

当子用户调用该 API 时,请留意以下说明:

  • 子用户只能指定其有权限访问的加速域名。子用户可以调用 ListCdnDomains 获取其有权限访问的加速域名。
  • 如果不指定该参数,表示所有该子用户有权限访问的那些加速域名。
www.example.com,img.example.com
Metric
String

表示一个指标。该参数有以下取值:

  • traffic:表示 CDN 向用户传输的数据量,单位是 bytes。
  • bandwidth:表示基于 CDN 向用户传输的数据量而计算的带宽,单位是 bps。
  • quic_requests:表示 CDN 收到的 QUIC 请求数量。
  • https_requests:表示 CDN 收到的 HTTPS 请求数量。该数量包含 QUIC 请求的数量。
  • tls_request:表示 CDN 投递到火山引擎日志服务的访问日志条数。
关于每个指标的详情以及统计方式,参见 指标的定义以及统计方式
traffic
BillingRegion
String

表示一个或多个计费区域,用于对用户请求进行过滤。该 API 对来自这些计费区域的用户请求统计 Metric 数据。多个计费区域之间使用逗号(,)分隔。该参数有以下取值:

  • CHN:表示中国内地。
  • EU:表示欧洲区。
  • NA:表示北美区。
  • SA:表示南美区。
  • MEA:表示中东区和非洲区。
  • AP1:表示亚太一区。
  • AP2:表示亚太二区。
  • AP3:表示亚太三区。
  • Oversea:表示除中国内地以外的所有计费区域。
如果不指定 BillingRegion,表示不使用该参数对请求进行过滤。
CHN

返回参数

参数名称
数据类型
参数说明
示例
TimestampPoint
Object[]
表示基于 Interval 统计出的一组 Metric 数据对象。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeBillingDetail&Version=2021-03-01
{
    "StartTime": 1717222134,
    "EndTime": 1717567734,
    "Metric": "traffic",
    "Project": "default",
    "Interval": "day",
    "BillingRegion": "CHN"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406112049254DAF81B2940D26288340",
        "Action": "DescribeBillingDetail",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "TimestampPoint": [
            {
                "TimeStamp": 1717171200,
                "Value": 4171303648
            },
            {
                "TimeStamp": 1717257600,
                "Value": 3761343058
            },
            {
                "TimeStamp": 1717344000,
                "Value": 4423846789
            },
            {
                "TimeStamp": 1717430400,
                "Value": 5922154856
            },
            {
                "TimeStamp": 1717516800,
                "Value": 9175283257
            }
        ]
    }
}

错误码

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