获取任务流模板列表
获取任务流模板列表
请求参数
字段 | 类型 | 是否必填 | 示例 | 描述 |
Action | String | 是 | ListWorkflowTemplate | 公共参数，本接口取值：ListWorkflowTemplate。 |
Names | Array of String | 否 | [test1,test2] | 任务流模板名字过滤条件，目前仅支持精准匹配。数组长度限制：100 |
Offset | Integer | 否 | 0 | 分页偏移量，默认值：0 |
Limit | Integer | 否 | 10 | 分页返回条数，最大不超过50 默认值：20 |
SpaceName | String | 否 | other_space1 | 应用空间 默认为：default_space |
返回参数
字段 | 类型 | 示例 | 描述 |
MediaProcessWorkflowTemplates | Array of MediaProcessWorkflowTemplate | 对应的任务流模板对象列表 | |
Limit | Integer | 10 | 返回的模板个数 |
Offset | Integer | 0 | 下次分页起始坐标 |
Total | Integer | 满足查询条件的模板总数 |
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=ListWorkflowTemplate' \
-H 'Content-Type: application/json' \
-d '{"Offset":0,"Limit": 10}'
-H <公共请求参数>
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"Limit": 10,
"Offset": 10,
"Total": 20,
"TemplateList": [
{
"WorkflowId": "xxx",
"WorkflowName": "trans_test",
"TranscodeTasks": [{
"TemplateId": "sdf3412eas"
}, {
"TemplateId": "fjsodq"
}
],
...
}
]
}
}
错误码
ErrorCode | ErrorMessage | 说明 | 状态码 |
InvalidArgument | name size is over 100 | 查询模板名称数组大小超过100 | 400 |
InvalidArgument | Limit is over 50 | limit超过限制 | 400 |
InvalidArgument | Limit is below 0 | limit小于0 | 400 |
InvalidArgument | Offset is below 0 | offset小于0 | 400 |