更新任务模板--视频点播-火山引擎

文档中心

立即注册

导航

视频点播

更新任务模板

最近更新时间：2023.08.04 11:00:29首次发布时间：2023.07.04 21:04:35

此接口用于更新任务模板内容。

说明

您需要设置所有参数，推荐先使用 GetTaskTemplate 获取所有参数后，修改相关值后再调用该接口。

请求说明

接口名称：UpdateTaskTemplate
接口地址：https://vod.volcengineapi.com?Action=UpdateTaskTemplate&Version=2023-07-01

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名称。当前接口取值为 `UpdateTaskTemplate`。
Version	String	是	接口版本。当前接口取值为 `2023-07-01`。
TemplateId	String	否	模板 ID。
Name	String	否	模板名称。
Description	String	否	模板描述。
TaskType	String	否	任务模板类型。 TranscodeVideo：视频转码模板。 ByteHD：极智超清模板。 TranscodeAudio：音频转码模板。 Snapshot：截图模板。
TranscodeVideoTaskParams	TranscodeVideoTaskParams	否	视频转码模板。说明当 `TaskType` 参数取值为 `TranscodeVideo`，该参数 `TranscodeVideoTaskParams` 必填。
ByteHDTaskParams	ByteHDTaskParams	否	极智超清模板。说明当 `TaskType` 参数取值为 `ByteHD`，该参数 `ByteHDTaskParams` 必填。
TranscodeAudioTaskParams	TranscodeAudioTaskParams	否	音频转码模板。说明当 `TaskType` 参数取值为 `TranscodeAudio`，该参数 `TranscodeAudioTaskParams` 必填。
SnapshotTaskParams	SnapshotTaskParams	否	截图模板。说明当 `TaskType` 参数取值为 `Snapshot`，该参数 `SnapshotTaskParams` 必填。

返回参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	响应通用信息

ResponseMetadata

参数	类型	描述
RequestId	String	请求 ID
Action	String	请求接口
Version	String	版本
Service	String	服务
Region	String	区域
Error	ResponseError	异常信息

ResponseError

参数	类型	描述
Code	String	错误码
Message	String	详细错误信息

示例

请求示例

https://vod.volcengineapi.com?Action=UpdateTaskTemplate&Version=2023-07-01&TemplateId=YourTemplateId&Name=YourName&Description=YourDescription&TaskType=YourTaskType&TranscodeVideoTaskParams=YourTranscodeVideoTaskParams&ByteHDTaskParams=YourByteHDTaskParams&TranscodeAudioTaskParams=YourTranscodeAudioTaskParams

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "UpdateTaskTemplate",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "UpdateTaskTemplate",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InternalError",
            "Message": "InternalError:some error!"
        }
    }
}

错误码

详见视频点播公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：