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

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immvideotest
TaskType	string	是	任务的类型，包含如下选项： CompressVideoTask：视频压缩任务。 GrabFrameTask：视频截帧任务。	VideoAnalyseTask
TaskId	string	否	任务ID。设置的任务ID必须与任务类型相对应。此参数为调用CreateVideoCompressTask或CreateGrabFrameTask接口后返回的Task ID。	VideoAnalyseTask-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":"VideoAnalyseTask","TgtUri":"oss://imm-test/testcases"}
TaskId	string	任务ID，和请求时一致。	VideoAnalyseTask-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	任务的类型，和请求时一致。	VideoAnalyseTask
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": "{\"EndTime\":\"\",\"GrabType\":\"time\",\"Interval\":\"1\",\"RequestId\":\"B8982C37-E03A-47CD-A715-D83D128D9FEB\",\"SrcUri\":\"oss://imm-test/testcases/video.mp4\",\"StartTime\":\"\",\"TaskType\":\"VideoAnalyseTask\",\"TgtUri\":\"oss://imm-test/testcases\"}",
  "TaskId": "VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779",
  "EndTime": "2021-01-28T03:24:25.915048Z",
  "RequestId": "C7593402-F428-47B1-80B2-F94B6859F119",
  "TaskType": "VideoAnalyseTask",
  "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\\\"}\"}"
}

错误码

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