You need to enable JavaScript to run this app.
导航
创建任务模板
最近更新时间:2023.08.04 11:00:29首次发布时间:2023.07.04 21:04:35
我的收藏
有用
有用
无用
无用

此接口用于创建任务模板。

请求说明

  • 接口名称:CreateTaskTemplate
  • 接口地址:http://vod.volcengineapi.com?Action=CreateTaskTemplate&Version=2023-07-01

请求参数

参数类型是否必选描述
ActionString接口名称。当前接口取值为 CreateTaskTemplate
VersionString接口版本。当前接口取值为 2023-07-01

SpaceName

String

点播空间名称。可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
NameString模板名称。
DescriptionString模板描述。

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 必填。

返回参数

参数类型描述
ResponseMetadataResponseMetadata响应通用信息
ResultVodTaskTemplateResult响应结果

ResponseMetadata

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息

ResponseError

参数类型描述
CodeString错误码
MessageString详细错误信息

VodTaskTemplateResult

参数类型描述
TaskTemplateTaskTemplate任务模板

TaskTemplate

参数类型描述
TemplateIdString模板 ID
SpaceNameString空间名
NameString模板名称
DescriptionString模板描述
TypeString工作流类型
CommitIdString版本 ID
HashString哈希
CreatedAtString创建时间,符合 RFC3339 规范。
UpdatedAtString更新时间,符合 RFC3339 规范。
TaskTypeString任务类型模板。
TranscodeVideoTaskParamsTranscodeVideoTaskParams视频转码模板。
ByteHDTaskParamsByteHDTaskParams极智超清模板。
TranscodeAudioTaskParamsTranscodeAudioTaskParams音频转码模板。
SnapshotTaskParamsSnapshotTaskParams截图模板。

示例

请求示例

http://vod.volcengineapi.com?Action=CreateTaskTemplate&Version=2023-07-01&SpaceName=YourSpaceName&Name=YourName&Description=YourDescription&TaskType=YourTaskType&TranscodeVideoTaskParams=YourTranscodeVideoTaskParams&ByteHDTaskParams=YourByteHDTaskParams&TranscodeAudioTaskParams=YourTranscodeAudioTaskParams

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "CreateTaskTemplate",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
        "Result": {
                "TaskTemplate": {
                        "TemplateId": "TemplateId",
                        "SpaceName": "SpaceName",
                        "Name": "Name",
                        "Description": "Description",
                        "CommitId": "CommitId",
                        "Hash": "Hash",
                        "CreatedAt": "2022-04-18T20:00:00Z",
                        "UpdatedAt":"2022-04-18T22:00:00Z",
                        "TaskType": "TaskType",
                        "TranscodeVideoTaskParams": {
                                "TranscodeTemplateType": "TranscodeTemplateType",
                                "Container": "Container",
                                "Video": {
                                        "Res": "Res",
                                        "ScaleMethod": "ScaleMethod",
                                        "ScaleType": 1,
                                        "ScaleMode": 1,
                                        "ScaleWidth": 1,
                                        "ScaleHeight": 1,
                                        "ScaleShort": 1,
                                        "ScaleLong": 1,
                                        "Codec": "Codec",
                                        "RateControlMode": "RateControlMode",
                                        "MaxBitrate": 1,
                                        "Bitrate": 1,
                                        "Crf": 0.1,
                                        "Preset": "Preset",
                                        "MaxFps": 1,
                                        "Vsync": "Vsync",
                                        "Fps": 0.1,
                                        "HDRMode": 0
                                },
                                "Audio": {
                                        "Codec": "Codec",
                                        "SampleRate": 1,
                                        "RateControlMode": "RateControlMode",
                                        "Bitrate": 1,
                                        "MinRate": 1,
                                        "MaxRate": 1,
                                        "Channels": 1,
                                        "Profile": "Profile"
                                },
                                "DisableAudio": "false",
                                "Quality": "Quality",
                                "UserTag": "UserTag",
                                "Encrypt": "false",
                                "Encryption": {
                                        "Vendor": "Vendor"
                                },
                                "Segment": {
                                        "Format": "Format",
                                        "Type": "Type",
                                        "Duration": 1
                                },
                                "Volume": {
                                        "Method": "Method",
                                        "IntegratedLoudness": 0.1,
                                        "TruePeak": 0.1,                                    
                                        "VolumeTime": "2019-10-12T07: 20: 50.52Z"
                                }
                        },
                        "ByteHDTaskParams": {
                                "Container": "Container",
                                "Video": {
                                        "Res": "Res",
                                        "ScaleMethod": "ScaleMethod",
                                        "ScaleType": 1,
                                        "ScaleMode": 1,
                                        "ScaleWidth": 1,
                                        "ScaleHeight": 1,
                                        "ScaleShort": 1,
                                        "ScaleLong": 1,
                                        "Codec": "Codec",
                                        "RateControlMode": "RateControlMode",
                                        "MaxBitrate": 1,
                                        "Bitrate": 1,
                                        "Crf": 0.1,
                                        "Preset": "Preset",
                                        "MaxFps": 1,
                                        "Vsync": "Vsync",
                                        "Fps": 0.1,
                                        "HDRMode": 0
                                },
                                "Audio": {
                                        "Codec": "Codec",
                                        "SampleRate": 1,
                                        "RateControlMode": "RateControlMode",
                                        "Bitrate": 1,
                                        "MinRate": 1,
                                        "MaxRate": 1,
                                        "Channels": 1,
                                        "Profile": "Profile"
                                },
                                "DisableAudio": "false",
                                "Quality": "Quality",
                                "UserTag": "UserTag",
                                "Encrypt": "false",
                                "Encryption": {
                                        "Vendor": "Vendor"
                                },
                                "Segment": {
                                        "Format": "Format",
                                        "Type": "Type",
                                        "Duration": 1
                                },
                                "Volume": {
                                        "Method": "Method",
                                        "IntegratedLoudness": 0.1,
                                        "TruePeak": 0.1,                                       
                                        "VolumeTime": "2019-10-12T07: 20: 50.52Z"
                                }
                        },
                        "TranscodeAudioTaskParams": {
                                "Container": "Container",
                                "Audio": {
                                        "Codec": "Codec",
                                        "SampleRate": 1,
                                        "RateControlMode": "RateControlMode",
                                        "Bitrate": 1,
                                        "MinRate": 1,
                                        "MaxRate": 1,
                                        "Channels": 1,
                                        "Profile": "Profile"
                                },
                                "Quality": "Quality",
                                "UserTag": "UserTag",
                                "Encrypt": "false",
                                "Encryption": {
                                        "Vendor": "Vendor"
                                },
                                "Segment": {
                                        "Format": "Format",
                                        "Type": "Type",
                                        "Duration": 1
                                },
                                "Volume": {
                                        "Method": "Method",
                                        "IntegratedLoudness": 0.1,
                                        "TruePeak": 0.1,
                                        "VolumeTime": "2019-10-12T07: 20: 50.52Z"
                                }
                        }
                }
        }
}

异常返回示例

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

错误码

详见视频点播公共错误码

服务端 SDK

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