查询直播录制路数、转封装用量

调用DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量。

使用说明

  • 统计每日录制并发路数、不同时间间隔打点数据。可以用来统计每日并发录制峰值路数、每月并发录制峰值路数。
  • 时移的路数不会被包含在录制路数中重复计算。
  • 支持到域名粒度查询,支持批量域名查询。批量查询时多个域名用英文逗号(,)分隔。
  • 数据粒度1分钟,最长查询跨度24小时,最长保存时间60天。
  • 数据粒度1小时,最长查询跨度31天,最长保存时间180天。
  • 数据粒度1天,最长查询跨度90天,最长保存时间366天。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveDomainRecordUsageData

系统规定参数。取值:DescribeLiveDomainRecordUsageData

DomainName String example.com

需要查询的主播流域名。

  • 支持单个或批量域名查询。批量查询时多个域名用英文逗号(,)分隔。
  • 不设默认返回所有域名合并后数据。
StartTime String 2021-05-10T20:00:00Z

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

  • 最小数据粒度为5分钟。
  • 不填默认读取过去24小时数据。
说明 起始时间最早可设置为从当前时间开始的90天内,精确到秒。
EndTime String 2021-05-10T21:00:00Z

结束时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。取值要求:

  • 需晚于起始时间(StartTime)。
  • 结束时间减去起始时间(查询数据的时间跨度)最长31天。超出31天请求失败并报错。
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,record_fmt

分组键。取值:

  • domain:查询结果按域名分组。
  • record_fmt:查询结果按录制类型分组。
说明 可选一个,也可多选。多选时用英文逗号(,)分隔。默认为domain,record_fmt。置为空或null的时候即不区分上述键。
Interval String 300

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

  • 60。
  • 300。
  • 3600。
  • 86400。
说明 不传或传值不支持时,查询时间跨度在31天以内的时间粒度默认值为300秒;查询时间跨度大于31天的时间粒度默认值为86400。

返回数据

名称

类型

示例值

描述

EndTime String 2021-05-10T21:00:00Z

结束时间。

StartTime String 2021-05-10T20:00:00Z

起始时间。

RequestId String 4B460F8B-993C-4F48-B98A-910811DEBFEB

请求ID。

RecordUsageData Array of DataModule

每个时间间隔的录制用量数据。

DataModule
Type String MP4

录制文件类型。

请求参数SplitBy取值包含record_fmt时有效。

Domain String example.com

主播流域名。

请求参数SplitBy取值包含domain时返回。

Region String cn-shanghai

地区。

TimeStamp String 2021-05-10T20:00:00Z

起始时刻。

Duration Long 3560

录制时长用量,单位:秒。

Count Long 1

峰值路数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainRecordUsageData
&StartTime=2021-05-10T20:00:00Z
&EndTime=2021-05-10T21:00:00Z
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeLiveDomainRecordUsageDataResponse>
    <StartTime>2021-05-10T20:00:00Z</StartTime>
    <EndTime>2021-05-10T21:00:00Z</EndTime>
    <RequestId>4B460F8B-993C-4F48-B98A-910811DEBFEB</RequestId>
    <RecordUsageData>
        <DataModule>
            <Type>MP4</Type>
            <Duration>3560</Duration>
            <Count>1</Count>
            <Domain>example.com</Domain>
            <TimeStamp>2021-05-10T20:00:00Z</TimeStamp>
        </DataModule>
    </RecordUsageData>
</DescribeLiveDomainRecordUsageDataResponse>

JSON格式

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

{
  "DescribeLiveDomainRecordUsageDataResponse" : {
    "StartTime" : "2021-05-10T20:00:00Z",
    "EndTime" : "2021-05-10T21:00:00Z",
    "RequestId" : "4B460F8B-993C-4F48-B98A-910811DEBFEB",
    "RecordUsageData" : {
      "DataModule" : {
        "Type" : "MP4",
        "Duration" : 3560,
        "Count" : 1,
        "Domain" : "example.com",
        "TimeStamp" : "2021-05-10T20:00:00Z"
      }
    }
  }
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidStartTime.Malformed Specified StartTime is malformed. StartTime参数错误,请您确认该StartTime参数是否正确。
400 InvalidEndTime.Malformed Specified EndTime is malformed. 结束时间错误,请您确认结束时间是否正确。
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 结束时间与开始时间不匹配,请您确认时间的匹配度。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400 InvalidRecordFmt.NotSupported The RecordFmt parameter is not supported. RecordFmt不支持查询输入的类型,请输入文档指定的格式
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. 传入的StartTime参数不支持。

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

特殊错误码

错误代码

描述

HTTP 状态码

语义

Throttling

Request was denied due to request throttling.

503

请求被流量控制限制。

InvalidDomain.NotFound

The domain provided does not belong to you.

404

域名不存在或不属于当前用户。