CDN加速

文档中心 API文档 请求数报表 查询多域名下多个直播流的流量带宽

查询多域名下多个直播流的流量带宽

更新时间:2021-04-14 14:41:27
适用产品:通用功能

接口描述

查询指定时间段内多域名下的各路流的流量。

请求参数

参数名称类型必填描述
dateFromString开始时间: 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过 10 分钟 ; 4.只能查询最近半年内数据。 5.dateFrom 和 dateTo 都不填则默认查询过去 10 分钟的数据
dateToString1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom; 3.如果大于当前时间,则重新赋值为当前时间;
domainStreamArray域名和流名组: 1.可传递的域名和流名组数量上限默认为20组(可联系技术支持调整); 2.域名domain:一组域名和流名组中只能传递单个域名,且域名必须传递; 3.流名stream:一组域名和流名组下(即单个域名下)可传递的流名数量上限默认为2000个(可联系技术支持调整),流名未传递时默认查询域名下所有流名,但当域名下流名数量超过限制时不可查询(报错)。
domainString域名: 1.可传递域名数量上限默认为200个 2.自动过滤掉非法域名(如传递非法域名,会被过滤掉,查询结果只返回合法域名的数据) 3.未传递该入参时,默认查询账号下所有域名,但当账号下域名数量超过上限时提示错误。
streamArray流名:“发布点”+“流名”。例如:live/test-20180101-test ,其中live是发布点,test-20180101-test是流名 不传,默认查询指定域名下的所有流的数据
dataIntervalString数据粒度 1.1m:1分钟粒度,5m:5分钟粒度 2.默认查询5分钟粒度数据
dataTypeString数据类型,flow:流量,bandwidth:带宽
filterEmptyStreamint是否过滤空流名 1.入参可选值 '0' 或 '1' ; 2.传参 0 不过滤流名为空的数据,传参 1 则过滤流名为空的数据 ; 3.默认值为 0 ;
keywordString查询字符串,不支持多个,支持正则查询

返回参数

参数名称类型描述
codeString请求结果状态码
messageString请求结果信息
dataObject请求结果的详细数据
domainString域名
streamString流名
totalFlowString总流量 1.保留2位小数,单位为MB; 2.当入参dataType为flow时,返回。 3.仅返回流量大于 0 的数据。
bandwidthPeakValueString峰值带宽 1.保留2位小数,单位Mbps 2.当入参dataType为bandwidth时,返回。 3.仅返回带宽大于 0 的数据。
timestampString时间 1.查询的数据粒度为1m时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:01,最后一个时间片是(yyyy-MM-dd+1) 00:00。 2.查询的数据粒度为5m时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:05,最后一个时间片是(yyyy-MM-dd+1) 00:00。
valueString时间点的数据 1.保留2位小数; 2.当入参dataType为flow时,value值为流量,单位为MB; 3.当入参dataType为bandwidth时,value值为带宽值,单位为Mbps;

错误码

错误代码(code)描述(message)HTTP状态码语义
24102013The accept header specified in your request is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
24102014This operation requires a body. Ensure that the body is present and the Content-Type header is set.400请求体没有传递
24102020The accept header specified in your request is not acceptable.400请求头时区不合法
24102002There was an error in the body of your HTTP request.400请求体格式错误
24102006The date specified is invalid.400dateFrom或dateTo不符合规范或时间区间不合法
24102007You cannot specify a period greater than xx minute(s).400dateFrom和dateTo相差超过限制值
24102019The request was rejected because the number of domain(xx) exceeds the limit (xx).400传递的域名个数超过账号限制
24102008param: dataType is null or invalid.400参数dataType 不符合规范
24102008param: domainStream is null or invalid.400参数domainStream 不符合规范
24102008param: stream is null or invalid.400参数stream 不符合规范
24102008param: domain is null or invalid.400参数domain不符合规范
24102008param: dataInterval is null or invalid.400参数dataInterval不符合规范
24102008param: filterEmptyStream is null or invalid.400参数filterEmptyStream 不符合规范
24102500We encountered an internal error. Please try again.500系统发生错误
24102010The number of stream is excessive once.400流个数超过上限

示例

示例说明
请求示例
复制
#!/bin/bash

# 请将示例中的(-H "X-Time-Zone") 参数设置为您希望在返回结果中获得的时区
# Please remember to change the param (-H "X-Time-Zone") in this demo to the TimeZone you want in response

username='example_username'

apiKey='example_apiKey'

date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`

password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`

curl -i --url "https://open.chinanetcenter.com/api/report/flow-bandwidth/stream/detail" \

-X "POST" \

-u "$username:$password" \

-H "Date: $date" \

-d '{

  "dateFrom": "2019-09-18T14:00:00+08:00",

  "dateTo": "2019-09-18T14:05:00+08:00",

  "domainStream": [

    {

      "domain": "aaa.a.com"

    },

    {

      "domain": "www.a.com"

    }

  ],

  "dataType": "flow",

  "dataInterval": "5m",

  "filterEmptyStream": 0,
"keyword":"^live/test-2019.*"

}'
返回示例
复制
{

  "code": "0",

  "message": "success",

  "data": [

    {

      "domain": "www.a.com",

      "domainOfStreamList": [

        {

          "stream": "live/test-20190101-test.flv",

          "totalFlow": "149.00",

          "detailList": [

            {

              "timestamp": "2019-09-18 14:00:00",

              "value": "20.00"

            },

            {

              "timestamp": "2019-09-18 14:05:00",

              "value": "129.00"

            }

          ]

        }

      ]

    }

  ]

}