查询指定计费区域的用量数据

最近更新时间:2021-03-30 16:18:41

查看PDF

GetDomainUsageData

描述

接口用于查询指定的加速产品类型/具体域名在各服务区域的用量原始计量数据,含带宽【单位:bps】、流量【单位:byte】、请求数(含动态http请求数、静态https请求数、动态https请求数、静态quic请求数、动态quic请求数)【单位:次】

  • 支持按指定的起止时间查询,且两者需要同时指定
  • 支持批量域名查询,默认查询账号下所有域名的数据
  • 单次查询最多可获取最近 一年 内 31天 跨度的数据
  • 支持指定查询粒度,含5分钟、1小时、1天三种粒度,默认为5分钟粒度数据
  • 时效性:5分钟延迟
  • 单次查询总返回数据点不超过10000个,域名数量不得超过1000个,且单次查询时间跨度至少包含一个时间粒度点(如,粒度为5分钟的时候,单次查询起止时间应大于等于五分钟)

请求语法

本接口请求需要包含指定目录/2020-06-30/statistics/GetDomainUsageData和公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
Metric String 需要获取的用量类型,一次只允许查询一种类型bandwidth:带宽数据traffic:流量数据static-https:静态https请求数dynamic-http:动态http请求数dynamic-https:动态https请求数static-quic:静态quic请求数dynamic-quic:动态quic请求数 PS:Metric取值为bandwidth或者traffic的时候areas生效,请求数不区分区域
CdnType String 当前产品类型,只允许输入一种类型,取值为file:大文件下载,video:音视频点播,page:图片小文件
Domains String 当前账户下选择时间段内正在运行状态的加速域名,可输入需要查询的域名,支持批量域名查询,多个域名用逗号(半角)分隔,缺省为全部域名,若产品类型和域名同时存在,进行强校验处理
Areas String 计费区域名称,区域罗列具体见下附录说明PS:只有Metric取值为bandwidth或者traffic的时候生效,单次只允许查询一个区域,缺省为 CN请求数不区分区域,当输入条件为请求数任意一种时,此处默认为全部区域
Interval Long 统计粒度,取值为 5:5分钟粒度;60:1小时粒度;1440:1天粒度;缺省为5分钟粒度5分钟及以上粒度的带宽峰值均取该粒度时间段内的5分钟粒度的最高峰值点单次查询最多可获取最近 一年 内 31天 跨度的数据

返回参数

参数名 类型及范围 说明
StartTime String 开始时间
EndTime String 结束时间
CdnType String 产品类型
Domains String 域名列表,逗号(半角)间隔
Areas String 区域
Interval Long 粒度
Metric Metric[] 需要获取的用量类型对应的数据值
RequestId String 请求ID
PeakTime String 当查询metric为bandwidth时,该值为峰值带宽时刻,其余情况不返回此值。

Metric

参数 类型 描述
Time String 时间点,当查询metric为bandwidth时,此值代表峰值时间点
Value Long 用量,单位:byte、bps、次数

示例

请求示例

GET方式:

GET /2020-06-30/statistics/GetUvData?StartTime=2020-09-01T08%3a00%2b0800&EndTime=2020-09-01T08%3a05%2b0800&Metric=bandwidth&CdnType=video
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetUvData
x-version: 2020-06-30

POST方式:

POST /2020-06-30/statistics/GetUvData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetUvData
x-version: 2020-06-30
Content-Type: application/json
{
    "StartTime":"2020-09-01T08:00+0800",
    "EndTime":"2020-09-01T08:05+0800",
    "Metric":"bandwidth",
    "CdnType":"video"
}

返回示例


文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

  • 内容不全,不深入
  • 内容更新不及时
  • 描述不清晰,比较混乱
  • 系统或功能太复杂,缺乏足够的引导
  • 内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈