查询任务流模板详情
请求参数
字段 | 类型 | 是否必填 | 示例 | 描述 |
Action | String | 是 | DescribeWorkflowTemplate | 公共参数，本接口取值：DescribeWorkflowTemplate。 |
WorkflowId | String | 是 | 12esf | 任务流模板Id |
SpaceName | String | 否 | other_space1 | 应用空间 默认为：default_space |
返回参数
字段 | 类型 | 示例 | 描述 |
CreateTime | String | 2021-12-05T10:20:09Z | 模板的创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
UpdateTime | String | 2021-12-05T10:20:09Z | 模板的更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。 |
WorkflowTemplate | MediaProcessWorkflowTemplate | 任务流模板信息 |
MediaProcessWorkflowTemplate
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
WorkflowId | String | 否 | 任务流ID | |
WorkflowName | String | 否 | 任务流名称。长度限制：64个字符。更新时传入会覆盖原有值，不传会保持原有值。只可设置字母、数字、中划线、下划线。 | |
Description | String | 否 | test | 模板描述信息，长度限制：256 个字符。更新时传入会覆盖原有值，不传会保持原有值 |
TranscodeTasks | Array of TranscodeTask | 否 | 视频转码模板列表。 更新时传入会覆盖原有值，不传会清空原有值 | |
SnapshotByTimeOffsetTasks | Array of SnapshotByTimeOffsetTask | 否 | 对视频按时间点截图任务列表。 更新时传入会覆盖原有值，不传会清空原有值 | |
SampleSnapshotTasks | Array of SampleSnapshotTask | 否 | 对视频采样截图任务列表。 更新时传入会覆盖原有值，不传会清空原有值 | |
ImageSpriteTasks | Array of ImageSpriteTask | 否 | 对视频截雪碧图任务列表。 更新时传入会覆盖原有值，不传会清空原有值 |
TranscodeTask
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
TemplateId | String | 否 | sdfsdr21 | 视频转码模板 ID。 |
SnapshotByTimeOffsetTask
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
TemplateId | String | 否 | sdfsdr21 | 指定时间点截图模板 ID。 |
SampleSnapshotTask
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
TemplateId | String | 否 | sdfsdr21 | 采样截图模板 ID。 |
ImageSpriteTask
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
TemplateId | String | 否 | sdfsdr21 | 雪碧图模板 ID。 |
API示例
请求示例
curl -X POST 'https://vod.streamlakeapi.com/?Action=DescribeWorkflowTemplate' \
-H 'Content-Type: application/json' \
-d '{"WorkflowId":"08ee8b63-6b80-433c-9786-decbe6f4a8a9"}'
-H <公共请求参数>
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId": "ELrQgYCgjp2IrAEYpgIgxLaiwZYxKMCgxJEL",
"ErrorCode": "",
"ErrorMessage": ""
},
"ResponseData": {
"WorkflowTemplate": {
"WorkflowId": "08ee8b63-6b80-433c-9786-decbe6f4a8a9",
"TranscodeTasks": [
{
"TemplateId": "a666412a-e174-4993-afbd-ac53f6bebb9a"
},
{
"TemplateId": "5d5e474e-349e-4bc8-ada4-fe7f487d696f"
}
],
"SampleSnapshotTasks": [
{
"TemplateId": "40a0aa26-0a2a-4410-a753-5112a001a36a"
}
],
"ImageSpriteTasks": [
{
"TemplateId": "bab4493c-8acc-4417-851e-0f2b7f6b7855"
}
],
"WorkflowName": "test_workflow_062101"
},
"CreateTime": "2023-06-21T09:00:59Z",
"UpdateTime": "2023-06-21T09:51:40Z"
}
}
错误码
ErrorCode | ErrorMessage | 说明 | 状态码 |
InvalidArgument | %s required arguments are missing | 必填参数为空 | 400 |
ResourceNotFound | WorkflowTemplate does not exist | 模板不存在 | 404 |