DescribeLiveDomainStreamTranscodeData - 查询域名转码用量数据

调用DescribeLiveDomainStreamTranscodeData查询域名转码用量数据。

接口说明

  • 可以用来统计每个时间间隔的网络带宽数据。
  • 支持批量域名查询,多个域名用英文逗号(,)分隔。
  • 最多可获取最近 90 天的数据。
  • 数据时间粒度为小时或天。
  • 不同转码类型与转码分辨率对应的计费档次,请参见直播转码计费说明中的转码账单中不同实例规格对应的转码计费档次说明。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

需要查询的主播流域名。

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

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

  • 最小数据时间粒度为 1 小时。
  • 不填默认读取过去 24 小时数据。
2017-12-10T20:00:00Z
EndTimestring

查询结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-12-10T22:00:00Z
Precisionstring

查询的时间精度。取值:

  • min(默认):以分钟为单位。
  • sec:以秒为单位。
min
Intervalstring

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

  • 3600:按小时粒度。
  • 86400:按天粒度。
说明 不填默认按小时。
3600
Splitstring

分组键。取值:

  • domain:域名。如果此参数 Split(分组键)取值为 domain 时,返回参数 Domain 才生效。
  • region:直播中心地域。如果此参数 Split(分组键)取值为 region 时,返回参数 Region 才生效。
  • transcode_type:转码类型。如果此参数 Split(分组键)取值为 transcode_type 时,返回参数 TanscodeType 才生效。
  • resolution:分辨率。如果此参数 Split(分组键)取值为 resolution 时,返回参数 Resolution 才生效。
  • fps:帧率。如果此参数 Split(分组键)取值为 fps 时,返回参数 Fps 才生效。

可选一个,也可多选,用英文逗号(,)分隔。

默认为domain,region,transcode_type,resolution,fps,即全部进行分组。

domain

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
TranscodeDataListarray<object>

每个时间间隔的网络带宽数据。

TranscodeDataobject
TanscodeTypestring

转码类型。取值:

说明 如果请求参数 Split(分组键)为 transcode_type 时,此返回参数才生效。
  • H264STD:H.264 普通转码。
  • H264NBHD:H.264 窄带高清转码。
  • H265STD:H.265 普通转码。
  • AUDIO:音频转码。
H264STD
Domainstring

主播流域名。

说明 如果请求参数 Split(分组键)为 domain 时,此返回参数才生效。
example.com
Regionstring

域名所属地域。 取值:

说明 如果请求参数 Split(分组键)为 region 时,此返回参数才生效。
  • cn-beijing:北京。
  • cn-shanghai:上海。
  • cn-qingdao:青岛。
  • cn-shenzhen:深圳。
  • ap-northeast-1:日本。
  • ap-southeast-1:新加坡。
  • ap-southeast-5:印尼。
  • eu-central-1:德国。
cn-beijing
Durationinteger

时长。单位:分钟。

2000
TimeStampstring

时间片起始时刻。

2017-12-10T20:00:00Z
Fpsstring

帧率。

说明 如果请求参数 Split(分组键)为 fps 时,此返回参数才生效。
normal
Resolutionstring

分辨率。取值:

说明 如果请求参数 Split(分组键)为 resolution 时,此返回参数才生效。
  • 2K
  • 4K
  • LD:流畅。
  • SD:标清。
  • HD:高清。
  • def:音频。
HD

示例

正常返回示例

JSON格式

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "TranscodeDataList": {
    "TranscodeData": [
      {
        "TanscodeType": "H264STD",
        "Domain": "example.com",
        "Region": "cn-beijing",
        "Duration": 2000,
        "TimeStamp": "2017-12-10T20:00:00Z",
        "Fps": "normal",
        "Resolution": "HD"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTime.MalformedSpecified StartTime is malformed.StartTime参数错误,请您确认该StartTime参数是否正确。
400InvalidEndTime.MalformedSpecified EndTime is malformed.结束时间错误,请您确认结束时间是否正确。
400InvalidParamPrecisionThe parameter Precision is invalid, please check StartTime and EndTime or Precision.Precision 参数错误,请检查StartTime、EndTime或者Precision 参数。
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配,请您确认时间的匹配度。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.传入的StartTime参数不支持。

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

变更历史

变更时间变更内容概要操作
2024-09-29OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情

特殊错误码

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