接口描述
接口名称:
/Task/DescribeTasks
。接口功能:查询任务信息,支持根据项目名称、项目 ID、素材 ID、任务 ID、任务类型和任务状态查询任务信息。
调用方式
输入参数
字段 | 类型 | 必填 | 描述 |
ProjectName | String | 否 | 根据项目名称查询任务。 |
ProjectId | String | 否 | 根据项目 ID 查询任务。 |
MaterialId | String | 否 | 根据媒体 ID 查询任务。 |
TaskIds | Array of String | 否 | 根据任务 ID 查询任务。 |
TaskTypeSet | Array of String | 否 | 根据任务类型查询。 |
StatusSet | Array of String | 否 | 根据任务状态查询。 |
Sort | 否 | 排序方式。Sort.Field 可选值:CreateTime。注意:指定 Text 搜索时,将根据匹配度排序,该字段无效。 | |
Offset | Integer | 否 | 偏移量。 |
Limit | Integer | 否 | 一页返回最大记录条数,最大不超过30。 |
输出参数
字段 | 类型 | 描述 |
TotalCount | Integer | 符合条件的记录总数。 |
TaskInfoSet | Array of TaskInfo | 任务信息。 |
示例
示例1:查询任务信息成功
查询任务 ID 为
1400293698-tfusion-e8476f5ba4e3f98d691bf415cfa978bdt0
任务信息,返回任务基本信息。输入示例
{"TaskIds": ["1400293698-tfusion-e8476f5ba4e3f98d691bf415cfa978bdt0"]}
输出示例
{"Code": "Success","Message": "成功","EnglishMessage": "success","Data": {"TotalCount": 1,"TaskInfoSet": [{"TaskId": "1400293698-tfusion-e8476f5ba4e3f98d691bf415cfa978bdt0","TaskType": "VIDEO_EDIT_PROJECT_EXPORT","Status": "SUCCESS","Progress": 100,"CreateTime": "2019-12-13T03:23:26.048Z"}]}}
示例2:查询任务信息失败
根据未关联的项目 ID 查找任务信息 ,返回错误。
输入示例
{"ProjectId": "cmepid_5fe012588b19a9000188815c"}
输出示例
{"Code": "ResourceNotFound","Message": "资源不存在","EnglishMessage": "resource not found"}