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

调试

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

请求参数

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

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

Project String immvideotest

项目名称。

RegionId String cn-hangzhou

项目所在地域的ID。

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

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

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

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

MaxKeys Integer 5

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

TaskType String VideoAnalyseTask

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

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

返回数据

名称 类型 示例值 描述
NextMarker String VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b

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

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

RequestId String B70908A5-02B8-4CEC-A660-2A8A10ADE862

当次请求的Request ID。

Tasks Array of Tasks

视频任务信息列表。

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。

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-8d7a4a32-f445-47fd-bdff-397a87651879

任务ID。

TaskType String VideoAnalyseTask

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListVideoTasks
&Project=immvideotest
&TaskType=VideoAnalyseTask
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

{
    "Tasks": [
        {
            "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-8d7a4a32-f445-47fd-bdff-397a87651879",
            "EndTime": "2021-01-28T03:24:25.915048Z",
            "TaskType": "VideoAnalyseTask",
            "StartTime": "2021-01-28T03:24:23.726372Z",
            "NotifyTopicName": "topic1",
            "ErrorMessage": "Success",
            "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\\\"}\"}"
        }
    ],
    "RequestId": "B70908A5-02B8-4CEC-A660-2A8A10ADE862",
    "NextMarker": "VideoAnalyseTask-4b5c5b94-ba39-4008-9342-30abe341792b"
}