logologo
售前咨询
点播云
产品简介
购买指南
快速入门
控制台指南
服务端API
调用方式
媒资上传
媒资管理
媒体处理
事件通知
点播CDN
数据统计
空间管理
回调配置
SDK文档
相关协议
文档中心
服务端API点播CDN查询CDN实时数据

查询CDN实时数据


1. 请求参数

字段

类型

是否必填

示例

描述

Action

String

DescribeDomainRealTimeCdnData

系统规定参数。取值:DescribeDomainRealTimeCdnData

DomainName

String

xxx.com

加速域名。若参数为空,值会被默认设置为all,默认返回所有加速域名合并后数据。支持批量查询(去重),多个用半角逗号(,)分隔,目前最多支持二十个加速域名。

StartTime

String

2022-01-01T10:20:00Z

获取数据起始时间点。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EndTime

String

2022-01-01T12:20:00Z

获取数据结束时间点,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

注:起始时间和结束时间的间隔根据参数Interval的值有不同限制。

Metric

String

flux

查询类型,支持以下类型:

  • flux:流量
  • bandwidth:带宽
  • 5xx:http状态码,5开头
  • 2xx:http状态码,2开头
  • 3xx:http状态码,3开头
  • 4xx:http状态码,4开头
  • fluxHitRate: 流量命中率
  • request:请求次数

Interval

String

5minutes

统计时间粒度。取值:

  • 5minutes:5分钟(最大时间间隔3天,最久查询最近93天的数据)
  • minute:1分钟(最大时间间隔12小时,最久查询最近7天的数据)
  • hour: 一小时(最大时间间隔7天,最久查询最近93天的数据)
  • day: 一天(最大时间间隔31天,最久查询最近93天的数据)

默认按时间跨度决定,小于等于12小时以1分钟为粒度,大于12小时小于三天则以5分钟为粒度  大于三天小于7天则以一小时为粒度,大于7天则以天为粒度。

SpaceName

String

122546

空间名称,不传按全部空间数据查询


2. 返回参数

参数名称

类型

示例值

描述

DomainName

String

xxx.com

加速域名。返回所有加速域名合并后数据。支持批量查询(去重),多个用半角逗号(,)分隔。(主域名)

Interval

String

minute

统计时间粒度。具体描述参考请求中的interval

Metric

String

flux

查询类型

Data

Array of DataItem


用量数据

DataItem

参数名称

类型

示例值

描述

TimeStamp

String

2022-01-01T10:00:00Z

时间片起始时刻。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Value

Object


详细使用数据

不同metric对应的内容不同

具体如下见下表

metric类型与返回的value对照表

metric

value 类型

value 单位

value描述

flux

float

byte

流量用量

bandwidth

float

bit/s

带宽用量

5xx

Array of HttpCodeInfo


5xx状态码

4xx

Array of HttpCodeInfo


4xx状态码

3xx

Array of HttpCodeInfo


4xx状态码

2xx

Array of HttpCodeInfo


4xx状态码

request

float

缓存命中率

fluxHitRate

float

%

请求次数

HttpCodeInfo

参数名称

类型

示例值

描述

Code

String

500

Http返回码。

Count

float

24

数量


3. 示例

3.1 请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=DescribeDomainRealTimeCdnData' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'accessKey: adfasdfasdfasfasfsa' \
-d 'EndTime=2015-12-10T10:21:00Z&StartTime=2015-12-10T10:20:00Z&Metric=flux&<公共参数>'


3.2 返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"DomainName" : "example.com",
"Interval" : "minute",
"Metric" : "flux",
"Data" : [
{
"TimeStamp" : "2015-12-10T10:20:00Z",
"Value" : 0
}, {
"TimeStamp" : "2015-12-10T10:21:00Z",
"Value" : 0
}
]
}
}


4. 错误码

ErrorCode

ErrorMessage

状态码

说明

InvalidArgument

Invalid Parameter.

400

参数错误。

InvalidArgument

Invalid Parameter StartTime.

400

StartTime参数错误。

InvalidArgument

Invalid Parameter EndTime.

400

EndTime参数错误。

InvalidArgument

interval Not Support

传入了不支持的interval

400

InvalidArgument

Invalid Parameter StartTime

传入非法startTime

400

InvalidArgument

Invalid Parameter EndTime

传入非法endTime

400

InvalidArgument

StartTime > EndTime

开始时间大于结束时间

400

InvalidArgument

StartTime > the current time

开始时间大于当前时间

400

上一篇:CDN预热下一篇:查询回源数据
该篇文档内容是否对您有帮助?
有帮助没帮助