创建工作流模板--视频点播-火山引擎

文档中心

立即注册

导航

创建工作流模板

最近更新时间：2023.12.22 11:38:56首次发布时间：2023.07.04 21:04:35

此接口用于创建工作流模板。

请求说明

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

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名称。当前接口取值为 `CreateWorkflowTemplate`。
Version	String	是	接口版本。当前接口取值为 `2023-07-01`。
SpaceName	String	否	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
Name	String	否	模板名称。
Description	String	否	模板描述。
Activities	Array of Activity	否	工作流任务集合。

返回参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	响应通用信息
Result	VodWorkflowTemplateResult	响应结果

ResponseMetadata

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

ResponseError

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

VodWorkflowTemplateResult

参数	类型	描述
WorkflowTemplate	WorkflowTemplate	工作流模板

WorkflowTemplate

参数	类型	描述
TemplateId	String	工作流模板 ID。
SpaceName	String	空间名称。
Name	String	模板名称。
Description	String	模板描述。
CreatedAt	String	创建时间，符合 RFC3339 规范。
UpdatedAt	String	更新时间，符合 RFC3339 规范。
CommitId	String	版本 ID。
Activities	Array of Activity	工作流设置节点集合。

示例

请求示例

https://vod.volcengineapi.com?Action=CreateWorkflowTemplate&Version=2023-07-01&SpaceName=YourSpaceName&Name=YourName&Description=YourDescription&Activities=YourActivities

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "CreateWorkflowTemplate",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
        "Result": {
                "WorkflowTemplate": {
                        "TemplateId": "TemplateId",
                        "SpaceName": "SpaceName",
                        "Name": "Name",
                        "Description": "Description",
                        "CreatedAt": "2022-04-18T20:00:00Z",
                        "UpdatedAt": "2022-04-18T22:00:00Z",
                        "CommitId": "CommitId",
                        "Activities": [{
                                        "ActivityId": "ActivityId",
                                        "Name": "Name",
                                        "Description": "Description",
                                        "Type": "Type",
                                        "SnapshotActivity": {
                                                "TemplateId": "TemplateId",
                                                "FileName": "FileName",
                                                "Condition": {
                                                        "ResRange": "ResRange",
                                                        "LongResRange": "LongResRange",
                                                        "DurationRange": "DurationRange",
                                                        "FpsRange": "FpsRange",
                                                        "BitrateRange": "BitrateRange",
                                                        "AudioBitrateRange": "AudioBitrateRange",
                                                        "FileType": "FileType",
                                                        "VQScoreRange": "VQScoreRange",
                                                        "VideoDurationRange": "VideoDurationRange",
                                                        "AudioDurationRange": "AudioDurationRange",
                                                        "UserCondition": "UserCondition"
                                                }
                                        },
                                        "EndActivity": {
                                                "TranscodeEvent": "TranscodeEvent"
                                        },
                                        "TranscodeActivity": {
                                                "TemplateId": "TemplateId",
                                                "Logo": {
                                                        "TemplateId": "TemplateId"
                                                },
                                                "FileName": "FileName",
                                                "Condition": {
                                                        "ResRange": "ResRange",
                                                        "LongResRange": "LongResRange",
                                                        "DurationRange": "DurationRange",
                                                        "FpsRange": "FpsRange",
                                                        "BitrateRange": "BitrateRange",
                                                        "AudioBitrateRange": "AudioBitrateRange",
                                                        "FileType": "FileType",
                                                        "VQScoreRange": "VQScoreRange",
                                                        "VideoDurationRange": "VideoDurationRange",
                                                        "AudioDurationRange": "AudioDurationRange",
                                                        "UserCondition": "UserCondition"
                                                }
                                        }
                                }
                        ]
                }
        }
}

异常返回示例

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

错误码

下表列举了本接口特有的错误码。视频点播公共错误码，详见公共错误码。

状态码	错误码	描述
403	RequestForbidden	账号访问受到限制

服务端 SDK

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