You need to enable JavaScript to run this app.
导航

查询回源统计数据

最近更新时间2023.12.20 12:07:26

首次发布时间2023.03.15 19:28:15

API 说明

API 名称:DescribeCdnOriginDataOffline
API 域名:open.volcengineapi.com
API 描述:查询 CDN/DCDN 回源统计数据。

注意

多云CDN从云服务商系统采集 CDN/DCDN 监控数据并存储,基于已存储数据向您提供数据查询服务。要使用该接口查询相关数据,您必须在多云CDN控制台开启 CDN/DCDN 监控数据同步。更多信息,请参见实时统计

请求方法

POST

使用限制

  • 节流限制:每个账号每秒最多可提交 50 个请求。
  • 云服务商数据获取的限制:
    部分云服务商未提供特定类型的 CDN/DCDN 监控数据,导致您调用本接口无法查询到相应数据。
    这些特殊情形包括:
    • AWS:默认不提供 CloudFront 监控数据的查询能力,但是允许通过日志查询监控数据。要通过多云CDN查询 AWS CloudFront 的监控数据,您必须在 AWS 控制台部署监控解决方案,然后在多云CDN控制台手动开启 CDN/DCDN 监控数据同步。更多信息,请参见数据同步
    • Akamai:未提供 AMD 和 DSA 监控数据的查询能力且不支持其他的数据查询方式,因此您无法通过多云CDN查询 Akamai AMD 和 DSA 的监控数据。
    • 七牛云:未提供 CDN 回源带宽、回源流量、回源请求数、回源状态码相关数据。
    • UCloud:未提供 CDN 回源流量数据。

    示例:
    假设您的域名同时由火山引擎 CDN 和 UCloud CDN 提供服务。
    当您按域名查询回源流量数据时,返回结果只包含从火山引擎 CDN 获得的回源流量数据,而不包含 UCloud CDN 的相关数据。

公共查询参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
示例
Action
String
API 的名称。该参数的取值是 DescribeCdnOriginDataOffline
DescribeCdnOriginDataOffline
Version
String
API 的版本。该参数的取值是 2022-03-01
2022-03-01

请求正文

参数名称
数据类型
是否必选
参数说明
示例
StartTime
Integer
指定一个时间段的起点,查询该时间段内(包含起点)的数据。使用时间戳表示,单位为秒。
时间段按照您设置的 Interval 值向前规整。示例:假设 Interval 为 5 分钟(对应秒级时间戳 300),那么 1644163200 和 1644163499 都会规整为 1644163200。
1668789300
EndTime
Integer
指定一个时间段的终点,查询该时间段内(不包含终点)的数据。使用时间戳表示,单位为秒。
时间段按照您设置的 Interval 值向前规整。示例:假设 Interval 为 5 分钟(对应秒级时间戳 300),那么 1644163200 和 1644163499 都会规整为 1644163200。
1668790200
Metric
String
指定一个要查询的指标。该参数有以下取值:
  • flux:流量(byte)
  • bandwidth:带宽(bps)
  • request: 请求数
  • status_all:2xx、3xx、4xx、5xx 状态码的汇总数量
  • status_2xx:2xx 状态码的汇总数量和某个具体 2xx 状态码(如 200、201 等)的数量
  • status_3xx:3xx 状态码的汇总数量和某个具体 3xx 状态码(如 301、302 等)的数量
  • status_4xx:4xx 状态码的汇总数量和某个具体 4xx 状态码(如 400、404 等)的数量
  • status_5xx:5xx 状态码的汇总数量和某个具体 5xx 状态码(如 500、502 等)的数量
flux
Interval
String
指定返回数据的时间间隔。该参数有以下取值:
  • 1min:每 1 分钟返回一个数据。查询的时间段必须在 1 天内,才支持该取值。
  • 5min:每 5 分钟返回一个数据。查询的时间段必须在 31 天内,才支持该取值。
  • hour:每 1 小时返回一个数据。查询的时间段必须在 90 天内,才支持该取值。
  • day:每 1 天返回一个数据。查询的时间段至少为 2 天,且最多为 90 天,才支持该取值。
5min
Vendors
Array
指定一个或多个云服务商,查询对应云服务商的数据。多个云服务商间使用半角逗号(,)分隔。默认返回所有云服务商的数据。该参数有以下取值:
  • aliyun:阿里云
  • tencent:腾讯云
  • ksyun:金山云
  • huawei:华为云
  • volcengine:火山引擎
  • wangsu:网宿科技
  • qiniu:七牛云
  • ucloud:UCloud
  • akamai:Akamai
  • baishan:白山云
  • aws:AWS
  • baidu:百度智能云
  • jingdong:京东云
aliyun
CloudAccountIds
Array
指定一个或多个云服务商的账号 ID,查询对应云服务商账号的数据。多个账号 ID 间使用半角逗号(,)分隔。默认返回所有账号的数据。
账号 ID 是您将云服务商账号绑定到多云CDN后,多云CDN为账号分配的唯一 ID。您可以调用 ListCloudAccounts 获取所有云服务商账号 ID。
6376e8be0b2233bf5431****
SubProducts
Array
指定一个或多个产品类型,查询对应产品的数据。多个产品类型间使用半角逗号(,)分隔。默认返回云服务商下支持的所有产品的数据。该参数有以下取值:
  • cdn:内容分发网络 CDN
    适用于除 UCloud、AWS、Akamai 以外的云服务商。
  • ucdn:UCloud CDN
  • cloudfront:AWS CloudFront
  • amd:Akamai AMD(Adaptive Media Delivery)
  • dsa:Akamai DSA(Dynamic Site Accelerator)
  • dcdn:全站加速 DCDN
    仅适用于阿里云和火山引擎。
  • ecdn:腾讯云全站加速网络 ECDN
  • edgeone:腾讯云边缘安全加速平台 EO
cdn
CdnTypes
Array
指定一个或多个业务类型,查询对应业务类型的数据。多个业务类型间使用半角逗号(,)分隔。默认返回云服务商下所有业务类型的数据。该参数有以下取值:
  • Web:网页/小文件加速
  • Video:音视频点播加速
  • Download:大文件下载加速
  • Dynamic:动态加速
  • Hybrid:混合加速
  • Live:直播加速
  • Default:其它
Web
Domains
Array
指定一个或多个域名,查询对应域名的数据。多个域名间使用半角逗号(,)分隔。最多允许设置 50 个域名。默认返回所有域名的数据。
您可以调用 ListCdnDomains 获取所有域名。
www.example.com
DomainIds
Array
指定一个或多个域名的 ID,查询对应域名的数据。多个域名 ID 间使用半角逗号(,)分隔。最多允许设置 50 个域名 ID。默认返回所有域名的数据。
域名 ID 是您将域名同步到多云CDN后,多云CDN为域名分配的唯一 ID。多云CDN为每个云服务商下的每个加速域名分配一个域名 ID。不同的域名 ID 可能对应相同的域名。您可以调用 ListCdnDomains 获取所有域名的 ID。
63aa6f9a0708929612b2****
GroupBy
String
指定一种返回数据的分组方式。默认返回汇总数据,即不对数据进行分组。该参数有以下取值:
  • vendor:按云服务商对数据分组
  • cloud_account_id:按云服务商账号对数据分组
  • sub_product:按子产品类型对数据分组
  • cdn_type:按业务类型对数据分组
  • domain:按域名对数据分组(仅在 Domains 不为空时支持该取值)
  • domain_id:按域名 ID 对数据分组(仅在 DomainIds 不为空时支持该取值)
vendor

响应正文

参数名称
数据类型
参数说明
示例
Resources
ResourceStatData[]
查询到的数据明细。

示例

请求示例

POST open.volcengineapi.com?Action=DescribeCdnOriginDataOffline&Version=2022-03-01&<其他公共请求参数>
{
    "StartTime": 1668789300,
    "EndTime": 1668790200,
    "Metric": "flux",
    "Interval": "5min",
    "CloudAccountIds": \["6376e8be0b2233bf5431****"\]
}

响应示例

{
    "ResponseMetadata": {
        "RequestID": "202212272213337222883A6F6C8D732329",
        "Action": "DescribeCdnOriginDataOffline",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Resources": [
            {
                "Name": "total",
                "Metrics": [
                    {
                        "Metric": "flux",
                        "Values": [
                            {
                                "Timestamp": 1668789300,
                                "Value": 798820526.9
                            },
                            {
                                "Timestamp": 1668789600,
                                "Value": 797321710.9
                            },
                            {
                                "Timestamp": 1668789900,
                                "Value": 791070505.5
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

错误代码

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