You need to enable JavaScript to run this app.
导航
创建用量导出任务
最近更新时间:2025.01.20 15:25:51首次发布时间:2022.10.31 16:28:43

创建一个任务,用来生成您加速域名的用量报告。调用该 API 后,您可以调用 ListUsageReports 获取用量报告的下载 URL。

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
BillingRegion
String

表示一个计费区域,用于对用户请求进行过滤。该参数有以下取值:

  • CHN:表示中国内地。
  • EU:表示欧洲区。
  • NA:表示北美区。
  • SA:表示南美区。
  • MEA:表示中东区和非洲区。
  • AP1:表示亚太一区。
  • AP2:表示亚太二区。
  • AP3:表示亚太三区。
CHN
StartTime
Long

表示该任务中统计时间段的开始时间,格式是 Unix 时间戳,精确到天。

  • StartTime 必须早于或者等于 EndTime
  • StartTime 与 EndTime 所表示的统计时间段不能超过 31 天。
  • StartTime 不能早于 2023年9月1日。
  • 如果 BillingCodecdn_peak_bandwidth_fourth_monthlyStartTime 与 EndTime 所表示的统计时间段必须大于或等于 3 天。
  • 如果 BillingCodecdn_bandwidth_dailyStartTime 与 EndTime 所表示的统计时间段不能超过 1 天。
1711900800
EndTime
Long
表示该任务中统计时间段的结束时间,格式是 Unix 时间戳,精确到天。
1714492799
ExportType
String

表示该任务的类型。该参数的取值如下:

  • domain:表示任务类型是 "域名明细"。用量报告中包含的是 Domain 参数指定的每个加速域名的用量数据。
  • account:表示任务类型是 "账户明细"。用量报告中包含的是您账号下所有加速域名用量数据的汇总。
domain
Metric
String

表示一个计费项。该参数有以下取值:

  • traffic:表示流量。
  • bandwidth:表示带宽。
  • quic_requests:表示 QUIC 请求数。
  • https_requests:表示 HTTPS 请求数。
  • tls_requests:表示日志投递条数。
traffic
TaskName
String
表示该任务的名称,长度为 3-63 个字符。任务名称只能包含小写字母、数字、下划线(_),并且只能以小写字母或数字开头和结尾。
my_task
Aggregate
String

表示是否聚合所有指定域名的用量。该参数有以下取值:

  • aggregate:表示聚合所有指定域名的用量。该 API 生成一个用量报告。
  • disaggregate:表示为每个指定的域名生成一个用量报告。
该参数仅当您指定了 Domain 时才生效。该参数的默认值为 aggregate
aggregate
Domain
String

表示一个加速域名列表,列表中的加速域名以逗号(,)分隔。列表中最多可以包含 50 个加速域名。当 ExportTypedomain 时,该参数有效。

用量报告中包含的是列表中每个加速域名的用量数据。
img.example.com,doc.example.com
CalculationMethod
String

表示 Metric 数据的汇总方式。

  • 如果 Metricbandwidth,该参数有以下取值:
    • daily_peak_bandwidth:表示日带宽峰值。
    • monthly_95th_percentile_bandwidth:表示月 95 带宽峰值。
    • daily_peek_monthly_avg:表示日峰值月平均带宽。
    • daily_95th_percentile_monthly_avg:表示日 95 月平均带宽。
    • monthly_4th_peak_bandwidth:表示月第四峰值带宽。
  • 如果 Metric 不是 bandwidth,该参数有以下取值:
    • sum_hourly:表示按小时汇总数据。
    • sum_daily:表示按天汇总数据。
关于汇总数据的计算方式,参见 计费说明
monthly_95th_percentile_bandwidth

返回参数

参数名称
数据类型
参数说明
示例
TaskId
String
表示创建的任务 ID。
1b972ae5f1494f9fa8710cd4c737a242

请求示例

POST https://cdn.volcengineapi.com/?Action=CreateUsageReport&Version=2021-03-01
{
    "ExportType": "domain",
    "BillingRegion": "CHN",
    "Domain": "img.example.com,doc.example.com",
    "TaskName": "mytask",
    "Metric": "traffic",
    "CalculationMethod": "sum_hourly",
    "StartTime": 1711900800,
    "EndTime": 1714492799,
    "Aggregate": "disaggregate"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024052615550133AE8D9DAAF80B5510CF",
        "Action": "CreateUsageReport",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "1b972ae5f1494f9fa8710cd4c737a242"
    }
}

错误码

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