最近更新时间:2022-06-15 10:57:07
接口用于查询指定的加速产品类型/具体域名在各服务区域的用量原始计量数据,含带宽【单位:bps】、流量【单位:byte】、请求数(含动态http请求数、静态https请求数、动态https请求数、静态quic请求数、动态quic请求数)【单位:次】
本接口请求需要包含指定目录/2020-09-01/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 | 计费区域名称,只允许输入单区域查询。取值:中国大陆 - CN,亚太一区 - AP1,亚太二区 - AP2,亚太三区 - AP3,北美洲 - NA,欧洲 - EU,非洲 - AF,南美洲 - SA。 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时,该值为峰值带宽时刻,其余情况不返回此值。 |
参数 | 类型 | 描述 |
---|---|---|
Time | String | 时间点,当查询metric为bandwidth时,此值代表峰值时间点 |
Value | Long | 用量,单位:byte、bps、次数 |
请求示例
GET方式:
GET /2020-06-30/statistics/GetDomainUsageData?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: GetDomainUsageData
x-version: 2020-09-01
POST方式:
POST /2020-09-01/statistics/GetDomainUsageData
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetDomainUsageData
x-version: 2020-09-01
Content-Type: application/json
{
"StartTime":"2020-09-01T08:00+0800",
"EndTime":"2020-09-01T08:05+0800",
"Metric":"bandwidth",
"CdnType":"video"
}
返回示例
{
"StartTime": "2021-09-01T08:00+0800",
"EndTime": "2021-09-01T08:05+0800",
"CdnType": "video",
"Domains": "a.test.com,b.test.com",
"Areas": "CN",
"Interval": 5,
"Metric": [
{
"Time": "2021-09-01T08:00+0800",
"Value": 2143
}
],
"RequestId": "7177e6d4-3abe-4794-b001-3655187166de",
"PeakTime": "2021-09-01T08:00+0800"
}
纯净模式