文档

ListVideoTasks - 列出视频类异步任务

更新时间:

调用ListVideoTasks接口列出视频任务信息。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
Projectstring

项目名称。

immvideotest
Markerstring

从Marker开始按字典序返回视频任务信息列表。如果不设置此参数,则从头开始返回视频任务。

此参数的值和返回结果中的NextMarker一致,用于继续读取未全部返回的音频信息。

VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b
MaxKeysinteger

返回视频任务的最大个数,默认值为100。

5
TaskTypestring

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

  • CompressVideoTask:视频压缩任务。
  • VideoAnalyseTask:视频分析任务。
  • GrabFrameTask:视频截帧任务。
VideoAnalyseTask

返回参数

名称类型描述示例值
object
Tasksobject []

视频任务信息列表。

EndTimestring

任务的结束时间。

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

2021-01-28T03:24:25.915048Z
Statusstring

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

  • Running:任务运行中。
  • Finished:任务执行完成,视频处理成功。
  • Failed:任务执行完成,视频处理失败。具体失败原因请参考ErrorMessage内容。
Finished
StartTimestring

任务开始执行的时间。

2021-01-28T03:24:23.726372Z
TaskTypestring

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

VideoAnalyseTask
Progressinteger

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

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

100
NotifyEndpointstring

异步反向通知的Endpoint。

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

http://1111111111.mns.cn-hangzhou.aliyuncs.com
ErrorMessagestring

错误信息。

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

Invalid Argument:VideoUri
Parametersstring

创建任务的参数,以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"}
Resultstring

任务处理的结果。

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

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

任务ID。

VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879
NotifyTopicNamestring

异步反向通知的TopicName。

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

topic1
RequestIdstring

当次请求的Request ID。

B70908A5-02B8-4CEC-A660-2A8A10ADE862
NextMarkerstring

下一次列出视频任务信息时以此值为Marker,将未返回的结果返回。

当视频任务未全部返回时,此参数才有值。

VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b

示例

正常返回示例

JSON格式

{
  "Tasks": [
    {
      "EndTime": "2021-01-28T03:24:25.915048Z",
      "Status": "Finished",
      "StartTime": "2021-01-28T03:24:23.726372Z",
      "TaskType": "VideoAnalyseTask",
      "Progress": 100,
      "NotifyEndpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
      "ErrorMessage": "Invalid Argument:VideoUri",
      "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\"}",
      "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\\\"}\"}",
      "TaskId": "VideoAnalyseTask-8d7a4a32-f445-47fd-bdff-397a87651879",
      "NotifyTopicName": "topic1"
    }
  ],
  "RequestId": "B70908A5-02B8-4CEC-A660-2A8A10ADE862",
  "NextMarker": "VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b"
}

错误码

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

  • 本页导读 (1)
文档反馈