调用GetVideoTask查询视频类任务_智能媒体管理(IMM)-阿里云帮助中心

调用GetVideoTask接口查询视频任务的执行状态和结果。

接口说明

此接口已不再维护，建议使用新版（2020-09-30 版本）接口 GetTask 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
imm:GetVideoTask		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immvideotest
TaskType	string	是	任务的类型，包含如下选项： CompressVideoTask：视频压缩任务。 GrabFrameTask：视频截帧任务。	CompressVideoTask
TaskId	string	否	任务 ID。设置的任务 ID 必须与任务类型相对应。此参数为调用 CreateVideoCompressTask 或 CreateGrabFrameTask 接口后返回的 Task ID。	CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779

返回参数

名称	类型	描述	示例值
	object
Status	string	任务运行状态。包括如下选项： Running：任务运行中。 Finished：任务执行完成，视频处理成功。 Failed：任务执行完成，视频处理失败。具体失败原因请参考 ErrorMessage 内容。	Finished
Progress	integer	任务进度的百分比。当前只有 0 和 100 两个结果。只有当转换成功时，此参数的返回值才为 100，其他情况均为 0。	100
NotifyEndpoint	string	异步反向通知的 Endpoint。如果创建任务时未设置此参数，则返回值为空。	http://1111111111.mns.cn-hangzhou.aliyuncs.com
Parameters	string	创建任务的参数，以 JSON 格式表示。	{ "EndTime": "", "GrabType": "time", "Interval": "1", "RequestId": "B8982C37-E03A-47CD-A715-D83D128D9FEB", "SrcUri": "oss://imm-test/testcases/video.mp4", "StartTime": "", "TaskType": "CompressVideoTask", "TgtUri": "oss://imm-test/testcases" }
TaskId	string	任务 ID，和请求时一致。	CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779
EndTime	string	任务的结束时间。当任务状态为 Finished 时，此参数才有值，否则返回值为空。	2021-01-28T03:24:25.915048Z
RequestId	string	当次请求的 Request ID。	C7593402-F428-47B1-80B2-F94B6859F119
TaskType	string	任务的类型，和请求时一致。	CompressVideoTask
StartTime	string	任务执行的开始时间。	2021-01-28T03:24:23.726372Z
NotifyTopicName	string	异步反向通知的 TopicName。如果创建任务时未设置此参数，则返回值为空。	topic1
ErrorMessage	string	错误信息。当任务状态为 Finished 时，此参数的值固定为 Success。当任务状态为 Failed 时，请参考此参数的值处理问题。	Invalid Argument:VideoUri
Result	string	任务处理的结果。不同的任务类型会有不同的返回信息，请以实际为准。	{"Key":"{\"TgtUri\":\"oss://imm-test/testcases\",\"ImgsUri\":\"oss://imm-test/testcases/imgs\",\"AudioUri\":\"oss://imm-test/testcases/audio\",\"ProcessLength\":\"10\",\"ResultUri\":\"oss://imm-test/testcases/result/result.txt\"}"}

示例

正常返回示例

JSON格式

{
  "Status": "Finished",
  "Progress": 100,
  "NotifyEndpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
  "Parameters": "{\n      \"EndTime\": \"\",\n      \"GrabType\": \"time\",\n      \"Interval\": \"1\",\n      \"RequestId\": \"B8982C37-E03A-47CD-A715-D83D128D9FEB\",\n      \"SrcUri\": \"oss://imm-test/testcases/video.mp4\",\n      \"StartTime\": \"\",\n      \"TaskType\": \"CompressVideoTask\",\n      \"TgtUri\": \"oss://imm-test/testcases\"\n}",
  "TaskId": "CompressVideoTask-c091c3f5-e6a5-46ce-a0f2-454bd779",
  "EndTime": "2021-01-28T03:24:25.915048Z",
  "RequestId": "C7593402-F428-47B1-80B2-F94B6859F119",
  "TaskType": "CompressVideoTask",
  "StartTime": "2021-01-28T03:24:23.726372Z",
  "NotifyTopicName": "topic1",
  "ErrorMessage": "Invalid Argument:VideoUri",
  "Result": "{\"Key\":\"{\\\"TgtUri\\\":\\\"oss://imm-test/testcases\\\",\\\"ImgsUri\\\":\\\"oss://imm-test/testcases/imgs\\\",\\\"AudioUri\\\":\\\"oss://imm-test/testcases/audio\\\",\\\"ProcessLength\\\":\\\"10\\\",\\\"ResultUri\\\":\\\"oss://imm-test/testcases/result/result.txt\\\"}\"}"
}

错误码

访问错误中心查看更多错误码。