You need to enable JavaScript to run this app.
导航

查询直播域名转码用量

最近更新时间2023.12.01 19:22:40

首次发布时间2021.11.22 11:40:05

支持查询用户直播转码时长数据。支持按照域名维度(含删除域名)查询,按天粒度聚合。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询直播域名转码用量接口。

注意事项

  • 请求频率:单用户请求频率限制为 100次/分钟
  • 数据延迟:数据延时为 20min

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeTranscodeData&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringDescribeTranscodeData接口名称。当前 API 的名称为 DescribeTranscodeData
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
DomainListArray of String["example.com","example2.com"]域名列表,缺省情况表示该用户的所有域名
StartTimeString2022-03-07T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2022-04-01T00:00:00+08:00
EndTimeString2022-03-08T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2022-04-02T00:00:00+08:00
AggregationInteger86400时间粒度,单位为 s,当前仅支持天粒度,默认值为 86400。单次查询时间跨度为 93d,历史查询时间范围为 93d

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
DomainListArray of String["example.com","example2.com"]域名列表
StartTimeString2022-03-07T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s
EndTimeString2022-03-08T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s
AggregationInteger86400时间粒度,单位为 s
DurationFloat12.860403541550001转码总时长,单位为分钟
ListArray of TranscodeData-聚合转码数据

TranscodeData

参数类型示例值描述

TranscodeType

String

Normal_H264

视频编码格式,支持的取值和含义如下所示。

  • Normal_H264:H.264 标准转码;
  • Normal_H265:H.265 标准转码;
  • ByteHD_H264:H.264 极智超清;
  • ByteHD_H265:H.265 极智超清;
  • Audio:纯音频流。

VCodec

String

Normal_H264

视频编码格式,同 TranscodeType 参数。支持的取值和含义如下所示。

  • Normal_H264:H.264 标准转码;
  • Normal_H265:H.265 标准转码;
  • ByteHD_H264:H.264 极智超清;
  • ByteHD_H265:H.265 极智超清;
  • Audio:纯音频流。

Resolution

String

720P

分辨率。

  • 480P:640 × 480;
  • 720P:1280 × 720;
  • 1080P:1920 × 1088;
  • 2K:2560 × 1440;
  • 4K:4096 × 2160;
  • 0:纯音频流。
TimeString2022-03-08T00:00:00+08:00聚合时刻
DurationFloat1.4475713543666666当前时间片内的转码时长,单位为分钟

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeTranscodeData&Version=2020-08-01
{
  "DomainList": [
    "example.com",
    "example2.com"
  ],
  "StartTime": "2022-03-07T00:00:00+08:00",
  "EndTime": "2022-03-08T00:00:00+08:00",
  "Aggregation": 86400
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100***",
    "Action": "DescribeTranscodeData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "DomainList": [
      "example.com",
      "example2.com"
    ],
    "StartTime": "2022-03-07T00:00:00+08:00",
    "EndTime": "2022-03-08T00:00:00+08:00",
    "Aggregation": 86400,
    "Duration": 12.860403541550001,
    "List": [
      {
        "Duration": 1.4475713543666666,
        "Resolution": "720P",
        "Time": "2022-03-07T00:00:00+08:00",
        "VCodec": "Normal_H264",
        "TranscodeType": "Normal_H264"
      },
      {
        "Duration": 11.412832187183334,
        "Resolution": "720P",
        "Time": "2022-03-08T00:00:00+08:00",
        "VCodec": "Normal_H264",
        "TranscodeType": "Normal_H264"
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。