GetVideoAnalysisTask - 视频理解-获取异步任务状态和结果

轻应用-获取视频理解异步任务结果

接口说明

百炼轻应用-视频理解-获取异步任务状态和结果:通过这个接口可以查看“提交异步任务”接口提交的视频理解任务状态和结果。欢迎前往视频理解控制台体验。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quanmiaolightapp:GetVideoAnalysisTaskget
*全部资源
*

请求语法

GET /{workspaceId}/quanmiao/lightapp/videoAnalysis/getVideoAnalysisTask HTTP/1.1

请求参数

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

百炼业务空间唯一标识:获取 workspaceId

llm-xxxx
taskIdstring

任务唯一标识

a3d1c2ac-f086-4a21-9069-f5631542f5a2

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

5D0E915E-655D-59A8-894F-93873F73AAE5
codestring

状态码

successful
messagestring

错误说明

success
httpStatusCodeinteger

http 状态码

200
successboolean

是否成功:true 成功,false 失败

True
dataobject

结果

headerobject

event 名称

errorCodestring

异常错误码

success
errorMessagestring

异常错误信息

Deduct task already success,Please do not resubmit.token '369e8f2c-d283-424a-96c4-c83efe08c89e'
eventstring

事件类型

TIMEOUT_CLOSE_ORDER
eventInfostring

事件描述

xxx
sessionIdstring

会话唯一标识

d5c38cf6-a4bf-4a57-a697-9f449926f0c9
taskIdstring

生成唯一标识

6e223291-729b-4e84-9271-c13ada1a776b
traceIdstring

全量路 ID

215045f817272303448235204efdef
payloadobject

结果

outputobject

结果

videoAnalysisResultobject

vl 对应生成内容

generateFinishedboolean

当前任务是否已生成结束

true
textstring

vl 生成文本结果

xxx
usageobject

Token 数量

inputTokenslong

输入 Token 数量

0
outputTokenslong

输出 Token 数量

0
totalTokenslong

总 Token 数量

0
videoShotAnalysisResultsarray<object>

分镜结果,暂不返回

videoShotAnalysisResultsobject

视频分镜结果

endTimelong

结束时间

1710432000000
startTimelong

开始时间,单位毫秒

2024-10-05 06:22:00
textstring

生成原始内容

广东丽诺
videoCaptionResultobject

视频字幕

generateFinishedboolean

当前任务是否已生成结束

true
videoCaptionsarray<object>

视频字幕

videoCaptionsobject

视频字幕

endTimelong

结束时间,单位毫秒

1736129678000
endTimeFormatstring

结束时间,格式化结果

00:01
startTimelong

开始时间,单位毫秒

00:01
startTimeFormatstring

开始时间,格式化结果

2025-01-07 11:52:06
textstring

字幕内容

xxxx
videoGenerateResultobject

文本总结结果

generateFinishedboolean

当前任务是否已生成结束

true
textstring

生成文本

xxx
usageobject

输出 Token 数量

inputTokenslong

输入 Token 数量

1
outputTokenslong

输出 Token 数量

1
totalTokenslong

总 Token 数量

2
videoMindMappingGenerateResultobject

脑图生成结束

generateFinishedboolean

当前任务是否已生成结束

true
textstring

生成文本

小吃街
usageobject

输入 Token 数量

inputTokenslong

输入 Token 数量

1
outputTokenslong

输出 Token 数量

1
totalTokenslong

总 Token 数量

2
videoMindMappingsarray<object>

脑图结果

videoMindMappingsobject

子节点

childNodesarray<object>

子节点

childNodesobject

子节点

childNodesarray<object>

子节点

childNodesobject

节点描述

namestring

节点描述

三级节点
namestring

节点描述

二级节点
namestring

节点描述

三级节点
videoTitleGenerateResultobject

标题生成结果

generateFinishedboolean

当前任务是否已生成结束

true
textstring

文本生成结果

xxxx
usageobject

Token 数量

inputTokenslong

输入 Token 数量

0
outputTokenslong

输出 Token 数量

0
totalTokenslong

总 Token 数量

0
resultJsonFileUrlstring

全量结果文件地址: 由于响应结果过大,部分数据获取改为文件方式,可以通过当前字段 url 下载文件,并解析使用。 当前包含的字段:

  • videoShotSnapshotResult(分片抽帧信息),数据结构定义见 RunVideoAnalysis 接口 其他字段获取方式不变,文本方式返回。 文件类型:json 文件内容:全量报文,包含文本方式返回的 返回 event:task-finished
usageobject

token 描述

inputTokenslong

输入 Token 数量

0
outputTokenslong

输出 Token 数量

0
totalTokenslong

总 Token 数量

0
taskRunInfoobject

运行信息

concurrentChargeEnableboolean

是否使用付给并发:true 时,按照实际运行时长计量

true
responseTimelong

运行时长:rt

1
taskStatusstring

任务状态。

  • PENDING:待执行
  • RUNNING:执行中
  • SUCCESSED:成功
  • SUSPENDED:暂停
  • FAILED:失败
  • CANCELED: 取消
SUCCESSED
taskIdstring

任务 ID

3feb69ed02d9b1a17d0f1a942675d300
errorMessagestring

异常错误信息

Access was denied, message: No such namespace namespaces/mjp-test-default.

示例

正常返回示例

JSON格式

{
  "requestId": "5D0E915E-655D-59A8-894F-93873F73AAE5",
  "code": "successful",
  "message": "success",
  "httpStatusCode": 200,
  "success": true,
  "data": {
    "header": {
      "errorCode": "success",
      "errorMessage": "Deduct task already success,Please do not resubmit.token '369e8f2c-d283-424a-96c4-c83efe08c89e'",
      "event": "TIMEOUT_CLOSE_ORDER",
      "eventInfo": "xxx",
      "sessionId": "d5c38cf6-a4bf-4a57-a697-9f449926f0c9",
      "taskId": "6e223291-729b-4e84-9271-c13ada1a776b",
      "traceId": "215045f817272303448235204efdef"
    },
    "payload": {
      "output": {
        "videoAnalysisResult": {
          "generateFinished": true,
          "text": "xxx",
          "usage": {
            "inputTokens": 0,
            "outputTokens": 0,
            "totalTokens": 0
          },
          "videoShotAnalysisResults": [
            {
              "endTime": 1710432000000,
              "startTime": 0,
              "text": "广东丽诺"
            }
          ]
        },
        "videoCaptionResult": {
          "generateFinished": true,
          "videoCaptions": [
            {
              "endTime": 1736129678000,
              "endTimeFormat": "00:01",
              "startTime": 0,
              "startTimeFormat": "2025-01-07 11:52:06",
              "text": "xxxx"
            }
          ]
        },
        "videoGenerateResult": {
          "generateFinished": true,
          "text": "xxx",
          "usage": {
            "inputTokens": 1,
            "outputTokens": 1,
            "totalTokens": 2
          }
        },
        "videoMindMappingGenerateResult": {
          "generateFinished": true,
          "text": "小吃街",
          "usage": {
            "inputTokens": 1,
            "outputTokens": 1,
            "totalTokens": 2
          },
          "videoMindMappings": [
            {
              "childNodes": [
                {
                  "childNodes": [
                    {
                      "name": "三级节点"
                    }
                  ],
                  "name": "二级节点"
                }
              ],
              "name": "三级节点"
            }
          ]
        },
        "videoTitleGenerateResult": {
          "generateFinished": true,
          "text": "xxxx",
          "usage": {
            "inputTokens": 0,
            "outputTokens": 0,
            "totalTokens": 0
          }
        },
        "resultJsonFileUrl": ""
      },
      "usage": {
        "inputTokens": 0,
        "outputTokens": 0,
        "totalTokens": 0
      }
    },
    "taskRunInfo": {
      "concurrentChargeEnable": true,
      "responseTime": 1
    },
    "taskStatus": "SUCCESSED",
    "taskId": "3feb69ed02d9b1a17d0f1a942675d300",
    "errorMessage": "Access was denied, message: No such namespace namespaces/mjp-test-default."
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissionYou are not authorized to perform this action , Please check the assignment of the workspaceId.请检查workspaceId的赋值

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