文档

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

更新时间:

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

接口说明

使用说明

  • 统计每日录制并发路数、不同时间间隔打点数据。可以用来统计每日并发录制峰值路数、每月并发录制峰值路数。

  • 时移的路数不会被包含在录制路数中重复计算。

  • 支持到域名粒度查询,支持批量域名查询。批量查询时多个域名用英文逗号(,)分隔。

  • 数据粒度 1 分钟,最长查询跨度 24 小时,最长保存时间 60 天。

  • 数据粒度 1 小时,最长查询跨度 31 天,最长保存时间 180 天。

  • 数据粒度 1 天,最长查询跨度 90 天,最长保存时间 366 天。

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveDomainRecordUsageDataget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DomainNamestring

需要查询的主播流域名。

  • 支持单个或批量域名查询。批量查询时多个域名用英文逗号(,)分隔。
  • 不设默认返回所有域名合并后数据。
example.com
StartTimestring

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

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

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

  • 需晚于起始时间(StartTime)。
  • 结束时间减去起始时间(查询数据的时间跨度)最长 31 天。超出 31 天请求失败并报错。
2021-05-10T21:00:00Z
Regionstring

地区。取值:

  • cn-beijing:北京

  • cn-shanghai:上海

  • cn-shenzhen:深圳

  • cn-qingdao:青岛

  • ap-southeast-1:新加坡

  • eu-central-1:德国

  • ap-northeast-1:东京

  • ap-southeast-5:雅加达

cn-shanghai
SplitBystring

分组键。取值:

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

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

  • 60。

  • 300。

  • 3600。

  • 86400。

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

返回参数

名称类型描述示例值
object
EndTimestring

结束时间。

2021-05-10T21:00:00Z
StartTimestring

起始时间。

2021-05-10T20:00:00Z
RequestIdstring

请求 ID。

4B460F8B-993C-4F48-B98A-910811DEBFEB
RecordUsageDataarray<object>

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

object
Typestring

录制文件类型。 请求参数 SplitBy 取值包含record_fmt时有效。

MP4
Domainstring

主播流域名。 请求参数 SplitBy 取值包含domain时返回。

example.com
Regionstring

地区。

cn-shanghai
TimeStampstring

起始时刻。

2021-05-10T20:00:00Z
Durationlong

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

3560
Countlong

峰值路数。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedSpecified StartTime is malformed.StartTime参数错误,请您确认该StartTime参数是否正确。
400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间错误,请您确认结束时间是否正确。
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.-
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配,请您确认时间的匹配度。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400InvalidRecordFmt.NotSupportedThe RecordFmt parameter is not supported.RecordFmt不支持查询输入的类型,请输入文档指定的格式
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.传入的StartTime参数不支持。
400LiveServiceNotFound%s-

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

特殊错误码

错误代码描述HTTP 状态码语义
ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。