查询转码任务--视频直播-火山引擎

文档中心

立即注册

导航

查询转码任务

最近更新时间：2024.07.31 16:32:21首次发布时间：2024.04.10 17:37:53

调用 TranscodingJobStatus 接口，查询直播流在近 3 天的转码记录和当前转码任务的状态。

注意事项

请求频率：单用户请求频率限制为 20 次/秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`TranscodingJobStatus`	接口名称。当前 API 的名称为 `TranscodingJobStatus`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。
Vhost	String	否	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的直播流使用的域名所属的域名空间。说明 Vhost 和 PushDomain 二选一必填。
PushDomain	String	否	`push.example.com`	推流域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的推流域名。说明 Vhost 和 PushDomain 二选一必填。
App	String	是	`live`	应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
Stream	String	是	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同，默认为空表示查询所有流名称。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
TranscodingTemplate	String	是	`hd`	转码配置的后缀，需去除转码后缀前的下划线（`_`）。如您配置的转码后缀为`_hd`，此处应传入`hd`。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
Data	Array of Data	`-`	转码任务记录信息。

Data

参数类型示例值描述

StartTime Integer 1711607649 本次转码任务的开始时间，Unix 时间戳，单位为秒。

参数	类型	示例值	描述
StartTime	Integer	`1711607649`	本次转码任务的开始时间，Unix 时间戳，单位为秒。
Status	String	`pending`	本次转码任务的状态，取值及含义如下所示。 `init`：转码任务初始化中； `fetched`：转码任务调度中； `pending`：转码任务即将开始； `doing`：转码任务进行中； `prestop`：转码任务即将结束； `done`：转码任务已结束。

Status

String

pending

本次转码任务的状态，取值及含义如下所示。

init：转码任务初始化中；
fetched：转码任务调度中；
pending：转码任务即将开始；
doing：转码任务进行中；
prestop：转码任务即将结束；
done：转码任务已结束。

请求示例

GET https://live.volcengineapi.com?Action=TranscodingJobStatus&Version=2023-01-01&Vhost=push.example.com&PushDomain=push.example.com&App=live&Stream=example_stream&TranscodingTemplate=hd

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "TranscodingJobStatus",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "StartTime": 1711521240,
                "Status": "done"
            },
            {
                "StartTime": 1711607649,
                "Status": "pending"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

状态码	错误码	错误信息	说明
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。

服务端 SDK

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