智能媒体管理 GetVideoTask

By | 2021年4月22日

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetVideoTask

操作接口名称,固定取值为GetVideoTask。

Project String immvideotest

项目名称。

TaskType String VideoAnalyseTask

任务的类型,包含如下选项:

  • CompressVideoTask:视频压缩任务。
  • VideoAnalyseTask:视频分析任务。
  • GrabFrameTask:视频截帧任务。
RegionId String cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com,例如当RegionId为cn-hangzhou时,地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

TaskId String VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779

任务ID。设置的任务ID必须与任务类型相对应。

此参数为调用CreateVideoAnalyseTaskCreateVideoCompressTaskCreateGrabFrameTask接口后返回的TaskId。

返回数据

名称 类型 示例值 描述
EndTime String 2021-01-28T03:24:25.915048Z

任务的结束时间。

当任务状态为Finished时,此参数才有值,否则返回值为空。

ErrorMessage String Invalid Argument:VideoUri

错误信息。

当任务状态为Finished时,此参数的值固定为Success。当任务状态为Failed时,请参考此参数的值处理问题。

NotifyEndpoint String http://1111111111.mns.cn-hangzhou.aliyuncs.com

异步反向通知的Endpoint。

如果创建任务时未设置此参数,则返回值为空。

NotifyTopicName String topic1

异步反向通知的TopicName。

如果创建任务时未设置此参数,则返回值为空。

Parameters String {"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"}

创建任务的参数,以JSON格式表示。

Progress Integer 100

任务进度的百分比。当前只有0和100两个结果。

只有当转换成功时,此参数的返回值才为100,其他情况均为0。

RequestId String C7593402-F428-47B1-80B2-F94B6859F119

当次请求的Request ID。

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\"}"}

任务处理的结果。

不同的任务类型会有不同的返回信息,请以实际为准。

StartTime String 2021-01-28T03:24:23.726372Z

任务执行的开始时间。

Status String Finished

任务运行状态。包括如下选项:

  • Running:任务运行中。
  • Finished:任务执行完成,视频处理成功。
  • Failed:任务执行完成,视频处理失败。具体失败原因请参考ErrorMessage内容。
TaskId String VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779

任务ID,和请求时一致。

TaskType String VideoAnalyseTask

任务的类型,和请求时一致。

示例

请求示例

http(s)://[Endpoint]/?Action=GetVideoTask
&Project=immvideotest
&TaskType=VideoAnalyseTask
&TaskId=VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779
&<公共请求参数>

正常返回示例

XML格式

<Status>Finished</Status>
<Progress>100</Progress>
<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"}</Parameters>
<TaskId>VideoAnalyseTask-c091c3f5-e6a5-46ce-a0f2-454bd779</TaskId>
<EndTime>2021-01-28T03:24:25.915048Z</EndTime>
<RequestId>C7593402-F428-47B1-80B2-F94B6859F119</RequestId>
<StartTime>2021-01-28T03:24:23.726372Z</StartTime>
<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\"}"}</Result>
<NotifyEndpoint>http://1111111111.mns.cn-hangzhou.aliyuncs.com</NotifyEndpoint>
<TaskType>VideoAnalyseTask</TaskType>
<NotifyTopicName>topic1</NotifyTopicName>
<ErrorMessage>Success</ErrorMessage>

JSON格式

{
    "Status": "Finished",
    "Progress": 100,
    "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",
    "StartTime": "2021-01-28T03:24:23.726372Z",
    "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\\\"}\"}",
    "NotifyEndpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
    "TaskType": "VideoAnalyseTask",
    "NotifyTopicName": "topic1",
    "ErrorMessage": "Success"
}

请关注公众号获取更多资料

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

Iconic One Theme | Powered by Wordpress