You need to enable JavaScript to run this app.
导航
多云CDN
  • 文档首页
    • /
  • 多云CDN

查询CDN边缘统计数据

最近更新时间：2023.09.06 11:03:28

首次发布时间：2022.12.29 10:10:01

我的收藏

API 说明

API 名称：DescribeCdnData
API 域名：open.volcengineapi.com
API 描述：查询用户对 CDN 节点的请求统计数据。

请求方法

POST

使用限制

  • 节流限制：每秒最多提交 30 个请求。
  • 云服务商 CDN 接口的限制：
    多云CDN调用云服务商 CDN 的相关接口以获取统计分析数据。由于云服务商 CDN 接口能力的限制，多云CDN不支持查询以下数据：
    • 七牛云 CDN：流量命中率、请求命中率
    • Akamai CDN：请求命中率、状态码相关数据

公共查询参数

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

参数名称
数据类型
是否必选
参数说明
示例
Action
String
是
API 的名称。该参数的取值是 DescribeCdnData。
DescribeCdnData
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 等）的数量
  • hitrate: 流量命中率（ %，保留两位小数）
  • request_hitrate：请求命中率（ %，保留两位小数）
如果您设置了以下参数，则不支持查询 hitrate 和 request_hitrate 指标：Region、Isp、Protocol、IpVersion。
flux
Interval
String
否
指定返回数据的时间间隔。该参数有以下取值：
  • 1min：1 分钟。查询的时间段必须在 1 天内，才支持该频率。
  • 5min（默认）：5 分钟。查询的时间段必须在 3 天内，才支持该频率。
  • hour：1 小时。查询的时间段必须在 31 天内，才支持该频率。
  • day：1 天。查询的时间段至少为 2 天，且最多为 90 天，才支持该频率。
不同云服务商支持的数据统计频率不同。详细说明，请参见数据粒度使用说明。
5min
Domain
String
否
指定一个或多个域名，查询对应域名的数据。多个域名间使用半角逗号（,）分隔。最多允许设置 10 个域名。
  • 您可以调用 ListCdnDomains 获取所有域名。
  • 该参数与 DomainId 和 CloudAccountId 必须三选一。
  • 如果您设置了多个域名，则默认返回这些域名的汇总数据。您可以通过 Aggregate 参数，设置是否按域名返回对应数据。
a.example.com,b.example.com
DomainId
String
否
指定一个或多个域名的 ID，查询对应域名的数据。多个域名 ID 间使用半角逗号（,）分隔。最多允许设置 10 个域名 ID。
  • 域名 ID 是您将域名同步到多云CDN后，多云CDN为域名分配的唯一 ID。多云CDN为每个云服务商下的每个加速域名分配一个域名 ID。不同的域名 ID 可能对应相同的域名。您可以调用 ListCdnDomains 获取所有域名的 ID。
  • 该参数与 Domain 和 CloudAccountId 必须三选一。
  • 如果您设置了多个域名 ID，则默认返回这些域名 ID 的汇总数据。您可以通过 Aggregate 参数，设置是否按域名 ID 返回对应数据。
63aa6f9a0708929612b2****
CloudAccountId
String
否
指定一个或多个云服务商的账号 ID，查询对应云服务商账号的数据。多个账号 ID 间使用半角逗号（,）分隔。
  • 账号 ID 是您将云服务商账号绑定到多云CDN后，多云CDN为账号分配的唯一 ID。您可以调用 ListCloudAccounts 获取所有云服务商账号 ID。
  • 该参数与 Domain 和 DomainId 必须三选一。
  • AWS 和七牛云不支持按照 CloudAccountId 查询数据。如需查询相关数据，您必须指定 Domain 或 DomainId。
  • 如果您设置了多个云服务商账号 ID，则默认返回这些账号的汇总数据。您可以通过 Aggregate 参数，设置是否按账号返回对应数据。
6376e8be0b2233bf5431****
Country
String
否
设置地区所属国家的英文代码。如果您设置 Region，则必须设置该参数为 CN。
CN
Region
String
否
设置一个地区的英文代码，查询对应地区的数据。
  • 您可以调用 DescribeCdnRegionAndIsp 获取地区的英文代码列表。
  • 该参数必须与 Country 同时使用，并且不能与 IpVersion 或 Protocol 同时使用。
SH
Isp
String
否
设置一个运营商的英文名，查询对应运营商的数据。
  • 您可以调用 DescribeCdnRegionAndIsp 获取运营商的英文名列表。
  • 该参数不能与 IpVersion 或 Protocol 同时使用。
TELECOM
Protocol
String
否
设置客户端请求的应用层协议，查询对应协议的数据。该参数有以下取值：
  • http
  • https
该参数不能与 IpVersion、Region 或 Isp 同时使用。
http
IpVersion
String
否
设置客户端请求的网络层协议，查询对应协议的数据。该参数有以下取值：
  • ipv4
  • ipv6
该参数不能与 Protocol、Region 或 Isp 同时使用。
ipv6
Aggregate
String
否
查询多个域名、域名 ID、云服务商账号的数据时，设置返回数据的类型。该参数有以下取值：
  • aggregate（默认）：返回汇总数据。
  • disaggregate：按域名、域名 ID、云服务商返回对应的数据。
如果您设置了 CloudAccountId，则通过该参数只能设置按云服务商返回对应数据，不支持按域名返回数据。
disaggregate

响应正文

参数名称
数据类型
参数说明
示例
Resources
ResourceStatData[]
查询到的数据明细。
VendorsMetaData
VendorMetaData[]
多云CDN向云服务商发起的查询请求的相关信息。

示例

请求示例

POST open.volcengineapi.com?Action=DescribeCdnData&Version=2022-03-01&<其他公共请求参数>
{
    "StartTime": 1668789300,
    "EndTime": 1668790200,
    "Metric": "flux",
    "CloudAccountId": "6376e8be0b2233bf5431****"
}

响应示例

{
    "ResponseMetadata": {
        "RequestID": "202212272213337222883A6F6C8D732329",
        "Action": "DescribeCdnData",
        "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
                            }
                        ]
                    }
                ]
            }
        ],
        "VendorsMetaData": null
    }
}

错误代码

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