全部产品
Search
文档中心

视频直播:查询延播时长数据

更新时间:Sep 03, 2024

调用DescribeLiveDelayedStreamingUsage查询延播时长用量数据。

  • 查询用户延播服务用量数据,默认粒度为1小时粒度。

  • 最大查询时间跨度:31天。

  • 最小查询时间粒度:1小时。

  • 最大查询时间范围:31天。

QPS限制

本接口的单用户QPS限制为5次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action

String

DescribeLiveDelayedStreamingUsage

系统规定参数。取值:DescribeLiveDelayedStreamingUsage。

DomainName

String

example.com

域名,多个域名使用逗号(半角)分隔.,默认为所有域名数据聚合输出。

StartTime

String

2022-10-10T20:00:00Z

获取数据起始时间点,日期格式按照ISO8601表示法,并使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ,默认返回近七天的数据。

EndTime

String

2022-10-10T21:00:00Z

结束时间需大于起始时间,时间跨度≤10小时;日期格式按照ISO8601表示法,并使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

StreamName

String

liveStream****

流名,多个流名使用逗号(半角)分隔,默认为所有流名数据聚合输出。

Region

String

cn-shanghai

查询不同直播中心, 支持批量地区查询,多个地区用逗号(半角)分隔。取值:

  • cn-beijing:北京

  • cn-shanghai:上海

  • cn-shenzhen:深圳

  • cn-qingdao:青岛

  • ap-southeast-1:新加坡

  • eu-central-1:德国

  • ap-northeast-1:东京

  • ap-southeast-5:雅加达

不传值时默认为所有区域数据聚合输出。

SplitBy

String

domain

分组键,若参数为空,则聚合输出用户数据,取值:

  • domain:域名。如果此参数Split(分组键)取值为domain时,返回参数Domain才生效。

  • region:直播中心地域。如果此参数Split(分组键)取值为region时,返回参数Region才生效。

  • stream:流名。如果此参数Split(分组键)取值为stream时,返回参数stream才生效。

说明

当分组键对应的参数不为空时才可以查询,否则返回错误。例如:当DomainName为空时不可以指定domain为分组键。

Interval

String

3600

查询数据的时间粒度。单位:秒。取值:

  • 300

  • 3600

  • 86400

不传或传值不支持时,使用默认值3600秒。

返回数据

名称

类型

示例值

描述

DelayData

Array of DelayDataItem

延播时长用量数据。

DelayDataItem

DomainName

String

example.com

用量域名,SplitBy指定domain时,分组输出。

Duration

Long

84

延播用量。

Region

String

cn-shanghai

直播中心,SplitBy指定region时,分组输出。

StreamName

String

liveStream****

流名,SplitBy指定stream时,分组输出。

TimeStamp

String

2022-10-10T20:00:00Z

时间片起始时刻。

EndTime

String

2022-10-10T21:00:00Z

结束时间。

RequestId

String

4B460F8B-993C-4F48-B98A-91081******

该条任务请求ID。

StartTime

String

2022-10-10T20:00:00Z

起始时间。

示例

请求示例

http://live.aliyuncs.com?Action=DescribeLiveDelayedStreamingUsage
&DomainName=www.example.com
&StartTime=2022-10-05T22:00:00Z
&EndTime=2022-10-06T03:00:00Z
&SplitBy=domain

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveDelayedStreamingUsageResponse>
    <RequestId>b83f5c8c-b07b-4ac8-90c5-96c0f922d394</RequestId>
    <StartTime/>
    <EndTime/>
    <DelayData>
        <DelayDataItem>
            <TimeStamp>2022-11-19T16:00:00Z</TimeStamp>
            <DomainName>www.example.com</DomainName>
            <Duration>60</Duration>
        </DelayDataItem>
        <DelayDataItem>
            <TimeStamp>2022-11-19T17:00:00Z</TimeStamp>
            <DomainName>www.example.com</DomainName>
            <Duration>60</Duration>
        </DelayDataItem>
    </DelayData>
</DescribeLiveDelayedStreamingUsageResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "b83f5c8c-b07b-4ac8-90c5-96c0f922d394",
  "StartTime" : "",
  "EndTime" : "",
  "DelayData" : {
    "DelayDataItem" : [ {
      "TimeStamp" : "2022-11-19T16:00:00Z",
      "DomainName" : "www.example.com",
      "Duration" : 60
    }, {
      "TimeStamp" : "2022-11-19T17:00:00Z",
      "DomainName" : "www.example.com",
      "Duration" : 60
    } ]
  }
}

错误码

HttpCode

错误码

错误信息

描述

400

InvalidParameter

The specified parameter is invalid.

参数错误,请依据API文档,核对需要输入的参数

400

InvalidTime.Malformed

Specified Time is malformed.

制定时间错误,请您确认该制定时间是否正确。

400

InvalidEndTime.Mismatch

Specified end time does not math the specified start time.

结束时间与开始时间不匹配,请您确认时间的匹配度。

400

InvalidTimeSpan

The time span exceeds the limit.

时间跨度超过限制,请参照接口文档,配置合理查询跨度。

访问错误中心查看更多错误码。