文档中心

获取工作流执行结果

最近更新时间：2024.04.10 12:06:28

首次发布时间：2023.02.13 20:56:31

此接口用于获取工作流执行结果。

使用说明

您可以通过 RunID（工作流任务 ID）获取工作流执行结果。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
时间范围：目前支持查询任务的时间范围为 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，用于唯一指示当前这次转码事件。可通过触发工作流接口获取。

返回参数

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

参数	类型	示例值	描述
RunId	String	`b926faef0e1***bd0801831c7c5`	执行 ID。
DirectUrl	Object of DirectUrl	`-`	存储路径。
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	Array of TranscodeInfos	`-`	音视频转码信息。
Snapshots	Array of Snapshots	`-`	截图转码信息。

DirectUrl

参数	类型	示例值	描述
FileName	String	`example.mp4`	文件路径。
BucketName	String	`tos-vn-**`	存储桶路径。

TranscodeInfos

参数	类型	示例值	描述
FileId	String	`fhgsue7347***`	文件 ID。
Md5	String	`xxx`	Hash 值。
FileType	String	`video`	文件类型。取值如下： `video`：视频。 `audio`：音频。
LogoType	String	`aa`	水印标签，用户自定义标签。
Encrypt	Boolean	`false`	是否加密。取值如下： `true`：加密，视频、音频加密。 `false`：不加密。
Format	String	`MP4`	编码格式。取值如下：视频转码：MP4、Dash、HLS、FLV、TS 音频转码：MP3、M4A、MP4、Dash、HLS、OGG
Duration	Float	`36`	时长，单位为 s
Size	Double	`1048`	文件大小，单位为字节。
StoreUri	String	`tos-vn-437**/example.mp4`	存储地址。
VideoStreamMeta	Object of VideoStreamMeta	`-`	视频流信息。
AudioStreamMeta	Object of AudioStreamMeta	`-`	音频流信息。
CreateTime	String	`2023-02-10 19:43:20`	创建时间。
DynamicRange	String	`HDR`	动态范围。取值如下： `HDR`：高动态范围。 `SDR`：标准动态范围。
TosStorageClass	String	`STANDARD`	视频存储类型。取值如下： `STANDARD`：标准存储。 `ARCHIVE`：归档存储。

Snapshots

参数	类型	示例值	描述
Type	String	`Sample`	截图类型。取值如下： `Poster`：静态图 `Dynpost`：动图 `AnimatedPoster`：反复循环动图 `AIDynpost`：AI 动图 `Sprite`：雪碧图 `Sample`：采样截图
Poster	Object of Poster	`-`	静态图。
Dynpost	Object of Dynpost	`-`	动图。
AnimatedPoster	Object of AnimatedPoster	`-`	反复循环动图。
AIDynpost	Object of AIDynpost	`-`	AI 动图。
Sprite	Object of Sprite	`-`	雪碧图。
Sample	Object of Sample	`-`	采样截图。

VideoStreamMeta

参数	类型	示例值	描述
Codec	String	`h264`	视频编码格式。
Height	Integer	`1080`	视频高度，单位为 px。
Width	Integer	`840`	视频宽度，单位为 px。
Duration	Float	`12`	视频时长，单位为 s。
Definition	String	`1080p`	视频清晰度。
Bitrate	Integer	`32034`	视频码率，单位为 bps。
Fps	Float	`30`	帧率。

AudioStreamMeta

参数	类型	示例值	描述
Codec	String	`aac`	音频编码格式。
Duration	Float	`15`	音频时长，单位为 s。
SampleRate	Integer	`44100`	音频采样率。
Bitrate	Integer	`3443`	音频码率，单位为 bps。
Quality	String	`higher`	音频质量。取值如下： `higher`：高音质。 `highest`：音乐音质。 `medium`：普通音质。
Channels	Integer	`4`	声道数。

Poster

参数	类型	示例值	描述
Format	String	`jpeg`	截图格式。
StoreUri	String	`tos*/cbe797357ecf439*c4a26b69dd5`	存储地址。
Width	Integer	`360`	截图宽度，单位为 px。
Height	Integer	`640`	截图高度，单位为 px。

Dynpost

参数	类型	示例值	描述
Format	String	`gif`	截图格式。
StoreUri	String	`tos*/c5d95e55fdbb*62c8c5f7e4a6aa`	存储地址。
Width	Integer	`360`	截图宽度，单位为 px。
Height	Integer	`640`	截图高度，单位为 px。

AnimatedPoster

参数	类型	示例值	描述
Format	String	`webp`	截图格式。
StoreUri	String	`tos*/89523e5554a74*9c6898761055a8`	存储地址。
Width	Integer	`540`	截图宽度，单位为 px。
Height	Integer	`960`	截图高度，单位为 px。

AIDynpost

参数	类型	示例值	描述
Format	String	`webp`	截图格式。
StoreUri	String	`tos*/89523e5554a74*9c6898761055a8`	存储地址。
Width	Integer	`540`	截图宽度，单位为 px。
Height	Integer	`960`	截图高度，单位为 px。

Sprite

参数	类型	示例值	描述
Format	String	`jpeg`	截图格式。
StoreUris	Array of 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

参数	类型	示例值	描述
Format	String	`jpeg`	截图格式。
StoreUris	Array of 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]}`
Offsets	Array of 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 各语言调用的示例代码，请参考如下：

视频点播