You need to enable JavaScript to run this app.
导航
查询边缘统计数据
最近更新时间:2024.04.22 11:04:23首次发布时间:2023.03.15 19:28:15

调用本接口查询加速域名的边缘统计数据。

说明

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

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制

使用限制

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

  • 云服务商数据获取的限制:
    部分云服务商未提供特定指标的监控数据,导致您调用本接口无法查询到相应数据。
    这些特殊情形包括:

    • AWS—CloudFront:默认不提供监控数据的查询能力,但是允许通过日志查询监控数据。要通过多云CDN查询 AWS CloudFront 的监控数据,您必须在 AWS 控制台部署监控解决方案,然后在多云CDN控制台手动开启加速域名监控数据同步。更多信息,请参见数据同步
    • Akamai—AMD 和 DSA:未提供监控数据的查询能力且不支持其他的数据查询方式,因此您无法通过多云CDN查询 Akamai AMD 和 DSA 的监控数据。
    • Google Cloud—Media CDN:未提供监控数据的查询能力且不支持其他的数据查询方式,因此您无法通过多云CDN查询 Google Cloud Media CDN 的监控数据。
    • 七牛云—CDN:未提供流量命中率、请求命中率数据。
    • 腾讯云—EdgeOne:未提供请求命中率数据。

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=DescribeCdnDataOffline&Version=2022-03-01

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
StartTime
Long
指定一个时间段的起点,查询该时间段内(包含起点)的数据。使用时间戳表示,单位为秒。
时间段按照您设置的 Interval 值向前规整。示例:假设 Interval 为 5 分钟(对应秒级时间戳 300),那么 16441632001644163499 都会规整为 1644163200
1704038400
EndTime
Long
指定一个时间段的终点,查询该时间段内(不包含终点)的数据。使用时间戳表示,单位为秒。
时间段按照您设置的 Interval 值向前规整。示例:假设 Interval 为 5 分钟(对应秒级时间戳 300),那么 16441632001644163499 都会规整为 1644163200
1704816000
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 等)的数量
  • hitrate: 流量命中率( %,保留两位小数)
  • request_hitrate:请求命中率( %,保留两位小数)
flux
Interval
String

指定返回数据的时间间隔。该参数有以下取值:

  • 1min:每 1 分钟返回一个数据。查询的时间段必须在 1 天内,才支持该取值。
  • 5min:每 5 分钟返回一个数据。查询的时间段必须在 31 天内,才支持该取值。
  • hour:每 1 小时返回一个数据。查询的时间段必须在 90 天内,才支持该取值。
  • day:每 1 天返回一个数据。查询的时间段至少为 2 天,且最多为 90 天,才支持该取值。
day
Vendors
String[]

指定一个或多个云服务商,查询对应云服务商的数据。多个云服务商间使用半角逗号(,)分隔。默认返回所有云服务商的数据。该参数有以下取值:

  • aliyun:阿里云
  • tencent:腾讯云
  • ksyun:金山云
  • huawei:华为云
  • volcengine:火山引擎
  • wangsu:网宿科技
  • qiniu:七牛云
  • ucloud:UCloud
  • akamai:Akamai
  • baishan:白山云
  • aws:AWS
  • baidu:百度智能云
  • jingdong:京东云
  • gcp:Google Cloud
  • chinamobile:中国移动
  • ctcdn:天翼云CDN+
aliyun
CloudAccountIds
String[]

指定一个或多个云服务商的账号 ID,查询对应云服务商账号的数据。多个账号 ID 间使用半角逗号(,)分隔。默认返回所有账号的数据。

说明

账号 ID 是您将云服务商账号添加到多云CDN后,多云CDN为账号分配的唯一 ID。您可以调用 ListCloudAccounts 接口获取所有云服务商账号 ID。

655372daa21faa599668****
SubProducts
String[]

指定一个或多个产品类型,查询对应产品的数据。多个产品类型间使用半角逗号(,)分隔。默认返回云服务商下所有支持的产品的数据。该参数有以下取值:

  • cdn:内容分发网络(CDN)
  • ucdn:UCloud UCDN
  • cloudfront:AWS CloudFront
  • amd:Akamai AMD
  • dsa:Akamai DSA
  • media_cdn:Google Cloud Media CDN
  • dcdn:全站加速(DCDN)
  • ecdn:腾讯云 ECDN
  • edgeone:腾讯云 EdgeOne
cdn
CdnTypes
String[]

指定一个或多个业务类型,查询对应业务类型的数据。多个业务类型间使用半角逗号(,)分隔。默认返回云服务商下所有业务类型的数据。该参数有以下取值:

  • Web:网页/小文件加速
  • Video:音视频点播加速
  • Download:大文件下载加速
  • Dynamic:动态加速
  • Hybrid:混合加速
  • Live:直播加速
  • Default:未配置
web
Domains
String[]

指定一个或多个加速域名,查询对应加速域名的数据。多个加速域名间使用半角逗号(,)分隔。最多允许设置 50 个加速域名。默认返回所有加速域名的数据。

说明

您可以调用 ListCdnDomains 接口获取所有加速域名。

www.example.com
DomainIds
String[]

指定一个或多个加速域名的 ID,查询对应加速域名的数据。多个加速域名 ID 间使用半角逗号(,)分隔。最多允许设置 50 个加速域名 ID。默认返回所有加速域名的数据。

说明

加速域名 ID 是多云CDN为(从云服务商平台同步的)加速域名分配的唯一标识符。加速域名 ID 在“云服务商/云产品/域名”维度是唯一的。您可以调用 ListCdnDomains 接口获取所有加速域名的 ID。

63aa6f9a0708929612b2****
GroupBy
String

指定一种返回数据的分组方式。默认返回汇总数据,即不对数据进行分组。该参数有以下取值:

  • vendor:按云服务商对数据分组
  • cloud_account_id:按云服务商账号对数据分组
  • sub_product:按子产品类型对数据分组
  • cdn_type:按业务类型对数据分组
  • domain:按域名对数据分组(仅在 Domains 不为空时支持该取值)
  • domain_id:按域名 ID 对数据分组(仅在 DomainIds 不为空时支持该取值)
vendor

响应正文

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

请求示例

POST https://open.volcengineapi.com/?Action=DescribeCdnDataOffline&Version=2022-03-01&<其他公共请求参数> 
{
    "StartTime": 1704038400,
    "EndTime": 1704816000,
    "Metric": "flux",
    "Interval": "day",
    "CloudAccountIds": [
        "655372daa21faa599668****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20240220164344472D6B818512980E9C44",
        "Action": "DescribeCdnDataOffline",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Resources": [
            {
                "Name": "total",
                "Metrics": [
                    {
                        "Metric": "flux",
                        "Values": [
                            {
                                "Timestamp": 1704038400,
                                "Value": 41914513357
                            },
                            {
                                "Timestamp": 1704124800,
                                "Value": 41970642815
                            },
                            {
                                "Timestamp": 1704211200,
                                "Value": 41921915299
                            },
                            {
                                "Timestamp": 1704297600,
                                "Value": 41911157301
                            },
                            {
                                "Timestamp": 1704384000,
                                "Value": 42036345713
                            },
                            {
                                "Timestamp": 1704470400,
                                "Value": 41677163034
                            },
                            {
                                "Timestamp": 1704556800,
                                "Value": 41483874830
                            },
                            {
                                "Timestamp": 1704643200,
                                "Value": 41671582202
                            },
                            {
                                "Timestamp": 1704729600,
                                "Value": 41458674261
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

错误码

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