此接口支持通过 TemplateId 模板 ID 获取工作流模板。
请求说明
- 接口名称：GetWorkflowTemplate
- 接口地址：http://vod.volcengineapi.com?Action=GetWorkflowTemplate&Version=2023-07-01
请求参数
| 参数 | 类型 | 是否必选 | 描述 |
|---|
| Action | String | 是 | 接口名称。当前接口取值为GetWorkflowTemplate。 |
| Version | String | 是 | 接口版本。当前接口取值为 2023-07-01。 |
| TemplateId | String | 否 | 模板 ID。 |
返回参数
| 参数 | 类型 | 描述 |
|---|
| RequestId | String | 请求 ID |
| Action | String | 请求接口 |
| Version | String | 版本 |
| Service | String | 服务 |
| Region | String | 区域 |
| Error | ResponseError | 异常信息 |
ResponseError
| 参数 | 类型 | 描述 |
|---|
| Code | String | 错误码 |
| Message | String | 详细错误信息 |
VodWorkflowTemplateResult
| 参数 | 类型 | 描述 |
|---|
| TemplateId | String | 任务模板 ID。 |
| SpaceName | String | 空间名称。 |
| Name | String | 工作流模板名称。 |
| Description | String | 工作流模板描述。 |
| CreatedAt | String | 创建时间，符合 RFC3339 规范。 |
| UpdatedAt | String | 更新时间，符合 RFC3339 规范。 |
| CommitId | String | 版本 ID。 |
| Activities | Array of Activity | 工作流任务节点。 |
示例
请求示例
http://vod.volcengineapi.com?Action=GetWorkflowTemplate&Version=2023-07-01&TemplateId=YourTemplateId
正常返回示例
{
"ResponseMetadata": {
"RequestId": "20220726*******************051B513A",
"Action": "GetWorkflowTemplate",
"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"
}
},
"End": {
"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": "GetWorkflowTemplate",
"Version": "2023-07-01",
"Service": "vod",
"Region": "cn-north-1",
"Error": {
"Code": "InternalError",
"Message": "InternalError:some error!"
}
}
}
错误码
详见视频点播公共错误码。
服务端 SDK
点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：