基于火山引擎内容分发网络(CDN)收到的用户请求,该 API 对一个指标统计其汇总数据。
要调用该 API,您需要指定一个指标,一个统计时间段和一个时间粒度。您还可以指定多个过滤条件对用户请求进行过滤。您最多能查询过去 92 天的数据。
数据稳定性:受网络波动影响,边缘节点上统计的指标数据可能会发生变化。大多数情况下,指标数据会在 12 小时内逐步稳定下来。
数据时效性:指标数据可能会有 5 分钟左右的延时。
节流限制:您每秒最多可以提交 20 个 API 请求。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 DescribeDistrictSummary 。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2021-03-01 。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
Metric | String | 是 | 表示一个统计指标。该参数有以下取值:
| traffic |
StartTime | Long | 是 | 表示统计时间段的开始时间,格式是 Unix 时间戳,精度是秒。 StartTime 必须早于或者等于 EndTime 。同时,StartTime 与 EndTime 所表示的统计时间段不能超过 31 天。 | 1710259200 |
EndTime | Long | 是 | 表示统计时间段的结束时间,格式是 Unix 时间戳,精度是秒。 | 1710836303 |
Interval | String | 否 | 表示一个时间粒度。该 API 基于 关于 该参数有以下取值:
您可以指定的时间粒度受
5min 。如果默认值不匹配时间范围,API 请求会失败。 | 5min |
Project | String | 否 | 表示一个项目。
| my_project |
Domain | String | 否 | 表示一个或多个加速域名,用于对用户请求进行过滤。该 API 对您指定的每个加速域名统计 如果您指定了 说明 当子用户调用该 API 时,请留意以下说明:
| www.example.com,www.test.com,img.example.com |
Location | String | 否 | 表示国家和地区的代码,用于对用户请求进行过滤。您可以指定一个或者多个代码,CDN 对来自这些国家和地区的用户请求统计
| CHN,AZE |
Province | String | 否 | 表示中国省级行政区的代码,用于对用户请求进行过滤。您可以指定一个或者多个代码,CDN 对来自这些省级行政区的用户请求统计 如果您不指定 | AH,BJ,CQ,FJ |
Isp | String | 否 | 表示请求所使用的中国网络运营商的代码,用于对用户请求进行过滤。例如,
| CT,CM,CU,GWBN |
Protocol | String | 否 | 表示请求使用的一个应用层协议,用于对用户请求进行过滤。该参数的可用值如下:
Protocol ,表示不使用该参数对请求进行过滤。 | https |
IpVersion | String | 否 | 表示请求使用的一个网络层协议,用于对用户请求进行过滤。该参数的可用值如下:
IpVersion ,表示不使用该参数对请求进行过滤。 | IPv4 |
在对一个项目统计指标数据时,CDN 统计的是项目内加速域名的数据。
示例
考虑以下场景:
在这个场景中,如果您对项目A 统计指标数据,则指标数据涵盖:
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
MetricDataList | Object[] | 表示该 API 返回的结果数据。 |
POST https://cdn.volcengineapi.com/?Action=DescribeDistrictSummary&Version=2021-03-01 { "Domain": "www.example.com,www.test.com,img.example.com", "StartTime": 1710259200, "EndTime": 1710835599, "Interval": "5min", "IpVersion": "IPv4", "Isp": "CT,CM,CU,GWBN", "Metric": "traffic", "Project": "my_project", "Protocol": "https", "Province": "AH,BJ,CQ,FJ" }
{ "ResponseMetadata": { "RequestId": "20240319203155E35F52346AABE9C47679", "Action": "DescribeDistrictSummary", "Version": "2021-03-01", "Service": "CDN", "Region": "cn-north-01" }, "Result": { "MetricDataList": [ { "Metric": "traffic", "Value": 154181 } ] } }
如果响应正文的 ResponseMetadata
字段中包含 Error
字段,则表示 API 请求失败。更多关于错误码的信息,参见错误码。