You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒体处理/获取工作流执行结果
获取工作流执行结果
最近更新时间：2024.10.24 19:51:48首次发布时间：2023.02.13 20:56:31
我的收藏

调用此接口传入工作流任务 ID 获取工作流执行结果。

注意事项

时间范围：目前支持查询任务的时间范围为 30 天。

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetWorkflowExecutionResult&Version=2022-12-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
GetWorkflowExecutionResult
接口名称。当前 API 的名称为 GetWorkflowExecutionResult。
Version
String
是
2022-12-01
接口版本。当前 API 的版本为 2022-12-01。
RunId
String
是
dfsd7469***349df
工作流任务 ID，用于唯一指示当前这次转码任务。可在 StartWorkflow 接口的返回参数中获取。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
RunId
String
b926faef0e1***bd0801831c7c5
工作流任务 ID。
DirectUrl
Object
-
DirectUrl 模式下文件存储路径。
FileName
String
example.mp4
文件路径。
BucketName
String
YourBucketName
存储桶名称。
Vid
String
v0c51bg7007***4jc77u6on28tm5g

视频 ID。

说明

DirectUrl 和 Vid 是互斥关系。

TemplateId
String
5372bbb2759***ad93274ed119
工作流 ID。
SpaceName
String
test
空间名称。
CallbackArgs
String
YourCallbackArgs
回调参数。
Status
String
0

执行状态。

  • 工作流任务执行完成后，取值如下：

    • 0：成功。
    • [1000,1999]：用户错误的失败。
    • [2000,2999]：系统错误的失败。

    说明

    具体详见工作流状态码。

  • 工作流任务执行过程中，取值如下：

    • PendingStart：排队中。
    • Running：执行中。

  • 用户终止操作，工作流任务执行结束时，取值如下：

    • Terminated：终止。
TranscodeInfos
Object[]
-
转码产物信息。
FileId
String
v020c9g10001***hs1v0go2sgujq0
文件 ID。
Md5
String
dd9fd3ad7f99f***ce70609aec68589
文件哈希值。
FileType
String
video

文件类型。取值如下：

  • video：视频。
  • audio：音频。
LogoType
String
a
水印贴片标签。即您在视频点播控制台创建水印贴片模板时配置的水印贴片标签，详见水印贴片模板。
Encrypt
Boolean
false

是否加密。取值如下：

  • false：不加密
  • true：加密
Format
String
mp3

编码格式。取值如下：

  • 视频转码：MP4、DASH、HLS、FLV、TS
  • 音频转码：MP3、M4A、MP4、DASH、HLS、OGG
Duration
Float
2.944
时长，单位为秒。
Size
Double
104847
文件大小，单位为字节。
StoreUri
String
tos-cn-v/34fdg***58sd.mp4
对象存储地址。
VideoStreamMeta
Object
-
视频流信息。
Codec
String
h264
视频编码格式。
Height
Integer
270
视频高度，单位为 px。
Width
Integer
480
视频宽度，单位为 px。
Duration
Float
2.944
视频时长，单位为 s。
Definition
String
720p
视频清晰度。
Bitrate
Integer
284910
视频码率，单位为 bps。
Fps
Float
25
帧率。
AudioStreamMeta
Object
-
音频流信息。
Codec
String
aac
音频编码格式。
Duration
Float
2.943
音频时长，单位为 s。
SampleRate
Integer
44100
音频采样率，单位为 Hz。
Bitrate
Integer
127658
音频码率，单位为 bps。
Quality
String
higher

音频质量，取值如下：

  • medium：普通音质
  • higher：高音质
  • highest：音乐音质
CreateTime
String
2021-04-02T02:47:33Z
创建时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
DynamicRange
String
HDR

动态范围。取值如下：

  • HDR：高动态范围。
  • SDR：标准动态范围。
TosStorageClass
String
STANDARD

视频存储类型。取值如下：

  • STANDARD：标准存储；
  • ARCHIVE：归档存储。
  • IA：低频存储。
Snapshots
Object[]
-
截图结果信息。
Type
String
Sample

截图类型。取值如下：

  • Poster：静态图
  • Dynpost：动图
  • AnimatedPoster：反复循环动图
  • AIDynpost：AI 动图
  • Sprite：雪碧图
  • Sample：采样截图
Poster
Object
-
静态图。
Format
String
jpeg
截图格式。
StoreUri
String
tos***/cbe797357ecf439***c4a26b69dd5
存储地址。
Width
Integer
360
截图宽度，单位为 px。
Height
Integer
640
截图高度，单位为 px。
Dynpost
Object
-
动图。
Format
String
gif

截图格式。取值如下：

  • jpeg
  • jpg
  • png
StoreUri
String
tos***/c5d95e55fdbb***62c8c5f7e4a6aa
存储地址。
Width
Integer
360
截图宽度，单位为 px。
Height
Integer
640
截图高度，单位为 px。
AnimatedPoster
Object
-
反复循环动图。
Format
String
webp
截图格式。
StoreUri
String
tos***/89523e5554a74***9c6898761055a8
存储地址。
Width
Integer
540
截图宽度，单位为 px。
Height
Integer
960
截图高度，单位为 px。
AIDynpost
Object
-
AI 动图。
Format
String
webp
截图格式。
StoreUri
String
tos***/89523e5554a74***9c6898761055a8
存储地址。
Width
Integer
540
截图宽度，单位为 px。
Height
Integer
960
截图高度，单位为 px。
Sprite
Object
-
雪碧图。
Format
String
jpeg
截图格式。
StoreUris
String[]
tos***/14437a144eb14***38b8b731f8a96
存储地址。
CellWidth
Integer
240
小图宽度，单位为 px。
CellHeight
Integer
360
小图高度，单位为 px。
ImgXLen
Integer
5
水平方向小图个数。
ImgYLen
Integer
5
垂直方向小图个数。
Interval
Float
10
截图间隔，单位为 s。
CaptureNum
Integer
1
截图张数。
Sample
Object
-
采样截图。
Format
String
jpeg
截图格式。
StoreUris
String[]
["tos***/fd5856116d7c45***906f37fabee"]

多张缩略图存储地址。在点播控制台的截图模板中配置采样截图的输出方式选择截图 Uri 时，结果在该参数 StoreUris 中获取。具体参数配置请参见配置采样截图参数。

说明

该 StoreUris 参数，会按照 Offsets 参数指定时间点依次返回截图。

Width
Integer
540
截图宽度，单位为 px。
Height
Integer
960
截图高度，单位为 px。
Interval
Float
10
截图间隔，单位为 s。
CaptureNum
Integer
1
截图张数。
Duration
Float
14
记录各个截图的时间点，默认会升序排序输出。
IndexUri
String
{"StoreUri": "xxx/uri1", "Offset": [2.5]}

截图 Index 文件 Uri 地址。在点播控制台的截图模板中配置采样截图的输出方式选择截图地址文件时，结果在该参数 IndexUri 中获取。具体参数配置请参见配置采样截图参数。文件格式的示例为 {"StoreUri": "xxx/uri1"}

  • 每行一个截图结果。
  • 该 IndexUri 参数，会按照 Offsets 参数指定时间点依次返回截图。示例：{"StoreUri": "xxx/uri1", "Offset": [2.5]}

说明

  • 每行一个截图结果。
  • 该 IndexUri 参数，会按照 Offsets 参数指定时间点依次返回截图。示例：{"StoreUri": "xxx/uri1", "Offset": [2.5]}
Offsets
Float[]
5
采样截图自定义采样时间点。

请求示例

https://vod.volcengineapi.com?Action=GetWorkflowExecutionResult&Version=2022-12-01

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202304271748***3807E684DCA0C6",
    "Action": "GetWorkflowExecutionResult",
    "Version": "2022-12-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Vid": "v0c51bg7007***4jc77u6on28tm5g",
    "RunId": "b926faef0e1***bd0801831c7c5",
    "SpaceName": "test",
    "TemplateId": "5372bbb2759***ad93274ed119",
    "Status": "0",
    "Snapshots": [
      {
        "Type": "Sample",
        "Sample": {
          "Format": "jpeg",
          "Width": 540,
          "Height": 960,
          "Interval": 10,
          "CaptureNum": 6,
          "Duration": 61.8,
          "IndexUri": "tos-vod-***425ab/61f70***82dbcc6b6d0840c3"
        }
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：