DescribeLiveTranscodeInfoData - 查询直播域名转码数据明细--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveTranscodeInfoData - 查询直播域名转码数据明细

最近更新时间：2024.12.09 11:34:49首次发布时间：2024.05.17 18:34:00

调用 DescribeLiveTranscodeInfoData 接口，查询指定时间范围内直播域名或直播流的转码任务 ID、流名称、转码后缀、转码开始时间和结束时间数据等明细数据。

注意事项

请求频率：单用户请求频率限制为 100 次/秒。
数据延迟：数据延迟为 20 分钟。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeLiveTranscodeInfoData&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLiveTranscodeInfoData`	接口名称。当前 API 的名称为 `DescribeLiveTranscodeInfoData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["push.example.com","push2.example.com"]`	域名列表，默认为空，表示查询您视频直播产品下所有域名的转码用量数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名。
App	String	否	`live`	应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。说明查询流粒度数据时，需同时传入 `App` 和 `Stream`。
Stream	String	否	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。说明查询流粒度数据时，需同时传入 `App` 和 `Stream`。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明历史查询最大时间范围为 366 天。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
TranscodeType	Array of String	否	`["Normal_H264","ByteHD_H265"]`	视频编码格式，默认为空表示不指定视频编码格式，支持的取值和含义如下所示。 `Normal_H264`：H.264 标准转码； `Normal_H265`：H.265 标准转码； `Normal_H266`：H.266 标准转码； `ByteHD_H264`：H.264 极智超清； `ByteHD_H265`：H.265 极智超清； `ByteHD_H266`：H.266 极智超清； `ByteQE`：画质增强； `Audio`：纯音频流。
Resolution	Array of String	否	`["720P","1080P"]`	转码分辨率档位，默认为空表示不指定转码分辨率档位。以 720P 为例，表示转码配置的长边 x 短边计算而出的面积大于 480P（640 × 480）且小于等于 720P 档位（1280 x 720）。支持的取值和含义如下所示。 `480P`：640 × 480； `720P`：1280 × 720； `1080P`：1920 × 1088； `2K`：2560 × 1440； `4K`：4096 × 2160； `8K`：> 4096 x 2160； `0P`：纯音频转码。
PageNum	Integer	否	`1`	查询数据的页码，默认为 1，表示查询第一页的数据。
PageSize	Integer	否	`20`	每页显示的数据条数。默认为 20，最大值为 100000。

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com","push2.example.com"]`	域名列表。
App	String	`live`	查询流粒度数据时的应用名称。
Stream	String	`example_stream`	查询流粒度数据时的流名称。
Resolution	Array of String	`["720P","1080P"]`	转码分辨率档位，以 720P 为例，表示转码配置的长边 x 短边计算而出的面积大于 480P（640 × 480）且小于等于 720P 档位（1280 x 720）。 `480P`：640 × 480； `720P`：1280 × 720； `1080P`：1936 × 1088； `2K`：2560 × 1440； `4K`：4096 × 2160； `8K`：> 4096 x 2160 `0P`：纯音频转码。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询的起始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
TranscodeInfoDataList	Array of TranscodeInfoDataList	`-`	所有时间粒度的数据。
Pagination	Object of Pagination	`-`	查询结果的分页信息。
TranscodeType	Array of String	`["Normal_H264","ByteHD_H265"]`	视频编码格式，支持的取值和含义如下所示。 `Normal_H264`：H.264 标准转码； `Normal_H265`：H.265 标准转码； `Normal_H266`：H.266 标准转码； `ByteHD_H264`：H.264 极智超清； `ByteHD_H265`：H.265 极智超清； `ByteHD_H266`：H.266 极智超清； `ByteQE`：画质增强； `Audio`：纯音频流。

TranscodeInfoDataList

参数	类型	示例值	描述
TaskID	String	`assf1****adasdn`	转码任务 ID。
Stream	String	`test_stream`	流名称。
TranscodeSuffix	String	`hd`	转码配置定义的转码后缀。
TranscodeType	String	`Normal_H264`	视频转码格式，取值和含义如下所示。 `Normal_H264`：H.264 标准转码； `Normal_H265`：H.265 标准转码； `Normal_H266`：H.266 标准转码； `ByteHD_H264`：H.264 极智超清； `ByteHD_H265`：H.265 极智超清； `ByteHD_H266`：H.266 极智超清； `ByteQE`：画质增强； `Audio`：纯音频流。
Resolution	String	`720P`	转码分辨率档位，以 720P 为例，表示转码配置的长边 x 短边计算而出的面积大于 480P（640 × 480）且小于等于 720P 档位（1280 x 720）。取值及含义如下所示。 `480P`：640 × 480； `720P`：1280 × 720； `1080P`：1936 × 1088； `2K`：2560 × 1440； `4K`：4096 × 2160； `8K`：> 4096 x 2160 `0P`：纯音频转码。
StartTime	String	`2022-03-07T00:00:00+08:00`	当前转码任务的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-03-08T00:00:00+08:00`	当前转码任务的结束时间，RFC3339 格式的时间戳，精度为秒。
Duration	Float	`1.4475713543666666`	当前转码任务在查询时间范围内的转码时长，单位为分钟。

Pagination

参数	类型	示例值	描述
PageCur	Integer	`1`	当前所在分页的页码。
PageSize	Integer	`100`	每页显示的数据条数。
TotalCount	Integer	`1000`	查询结果的数据总条数。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveTranscodeInfoData&Version=2023-01-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeLiveTranscodeInfoData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainList": [
            "push.example.com",
            "push2.example.com"
        ],
        "StartTime": "2021-04-13T00:00:00+08:00",
        "EndTime": "2021-04-14T00:00:00+08:00",
        "App": "live",
        "Stream": "example_stream",
        "Resolution": [
            "720P"
        ],
        "TranscodeInfoDataList": [
            {
                "Duration": 1.4475713543666666,
                "Resolution": "720P",
                "TranscodeType": "Normal_H264",
                "Stream": "example_stream",
                "TranscodeSuffix": "hd",
                "StartTime": "2022-03-07T00:00:00+08:00",
                "EndTime": "2022-03-08T00:00:00+08:00",
                "TaskID": "assf1****adasdn"
            }
        ],
        "Pagination": {
            "PageCur": 1,
            "PageSize": 100,
            "TotalCount": 1000
        },
        "TranscodeType": [
            "Normal_H264"
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。

SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。