获取工作流模板列表--视频点播-火山引擎

文档中心

立即注册

导航

获取工作流模板列表

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

此接口用于获取工作流模板列表。

请求说明

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

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名称。当前接口取值为 `ListWorkflowTemplate`。
Version	String	是	接口版本。当前接口取值为 `2023-07-01`。
SpaceName	String	否	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
TemplateId	String	否	模板 ID。
Name	String	否	模板名称。
Limit	int32	否	返回个数。取值范围为 (0,100]。默认为 30。
Offset	int32	否	偏移量。需大于等于 0。
OrderByKey	String	否	排序 key。取值如下： created_at：创建时间。 updated_at：更新时间。
Order	String	否	顺序。取值如下： desc：降序。 asc：升序。

返回参数

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

ResponseMetadata

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

ResponseError

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

VodListWorkflowTemplateResult

参数	类型	描述
Limit	int32	返回个数。
Offset	int32	偏移量。
Total	int64(Json中为String)	工作流模板总数。
Data	Array of WorkflowTemplate	工作流模板信息。

WorkflowTemplate

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

示例

请求示例

http://vod.volcengineapi.com?Action=ListWorkflowTemplate&Version=2023-07-01&SpaceName=YourSpaceName&TemplateId=YourTemplateId&Name=YourName&Limit=YourLimit&Offset=YourOffset&OrderByKey=YourOrderByKey&Order=YourOrder

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "ListWorkflowTemplate",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
        "Result": {
                "Limit": 1,
                "Offset": 1,
                "Total": "Total",
                "Data": [{
                                "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": "ListWorkflowTemplate",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InternalError",
            "Message": "InternalError:some error!"
        }
    }
}

错误码

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

服务端 SDK

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