调用 RestartTranscodingJob
接口,重启状态异常的转码任务。
您可以调用 [TranscodingJobStatus](https://www.volcengine.com/docs/6469/1250187)
接口查看直播流的转码任务状态,当前转码任务状态为 init
、fetched
、pending
或 doing
时,您可以调用本接口重启转码任务。
请求频率:单用户请求频率限制为 20 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RestartTranscodingJob | 接口名称。当前 API 的名称为 RestartTranscodingJob 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
Vhost | String | 否 |
| 域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,查看需要查询的直播流使用的域名所属的域名空间。 说明 Vhost 和 PushDomain 二选一必填。 |
PushDomain | String | 否 |
| 推流域名。您可以调用 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 。 |
本接口无特有的返回参数。更多信息请见返回结构。
GET https://live.volcengineapi.com?Action=RestartTranscodingJob&Version=2023-01-01&Vhost=push.example.com&App=live&Stream=example_stream&TranscodingTemplate=hd
{ "ResponseMetadata": { "RequestId": "202306041104200100100232280022D31", "Action": "RestartTranscodingJob", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" } }
您可访问公共错误码,获取更多错误码信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.AccountIDNotAllowed | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
404 | ResourceNotFound.VhostNotExist | vhost not found | 未找到域名空间(Vhost)。请检查传入的域名空间是否与实际使用的域名空间一致。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误,请联系技术支持。 |
500 | InternalError.VhostOrDomain | an internal error related to vhost or domain occurred, please contact the administrator. | 出现与域名空间(Vhost)或域名(Domain)相关的内部错误。请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。