You need to enable JavaScript to run this app.
导航

获取工作流执行结果

最近更新时间2024.01.18 14:39:29

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

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

使用说明

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

注意事项

  • 请求频率:单用户请求频率限制为 50 次/秒
  • 时间范围:目前支持查询任务的时间范围为 30 天

请求说明

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

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringGetWorkflowExecutionResult接口名称。当前 API 的名称为 GetWorkflowExecutionResult
VersionString2022-12-01接口版本。当前 API 的版本为 2022-12-01
RunIdStringdfsd7469***349df工作流任务 ID,用于唯一指示当前这次转码事件。可通过触发工作流接口获取。

返回参数

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

参数类型示例值描述
RunIdStringb926faef0e1***bd0801831c7c5执行 ID。
DirectUrlObject of DirectUrl-存储路径。

Vid

String

v0c51bg7007***4jc77u6on28tm5g

视频 ID。

说明

DirectUrlVid 是互斥关系。

TemplateIdString5372bbb2759***ad93274ed119工作流模板 ID。
SpaceNameStringtest点播空间名称。
CallbackArgsStringYourCallbackArgs回调参数。

Status

String

0

执行状态。取值如下:

  • 0:成功。
  • [1000,1899]:用户错误的失败。
  • [1900,2999]:系统错误的失败。
  • PendingStart:排队中。
  • Running:执行中。
  • Terminated:终止。

说明

具体详见工作流状态码

TranscodeInfosArray of TranscodeInfos-音视频转码信息。
SnapshotsArray of Snapshots-截图转码信息。

DirectUrl

参数类型示例值描述
FileNameStringexample.mp4文件路径。
BucketNameStringtos-vn-**存储桶路径。

TranscodeInfos

参数类型示例值描述
FileIdStringfhgsue7347***文件 ID。
Md5StringxxxHash 值。

FileType

String

video

文件类型。取值如下:

  • video:视频。
  • audio:音频。
LogoTypeStringaa水印标签,用户自定义标签。

Encrypt

Boolean

false

是否加密。取值如下:

  • true:加密,视频、音频加密。
  • false:不加密。

Format

String

MP4

编码格式。取值如下:

  • 视频转码:MP4、Dash、HLS、FLV、TS
  • 音频转码:MP3、M4A、MP4、Dash、HLS、OGG
DurationFloat36时长,单位为 s
SizeDouble1048文件大小,单位为字节。
StoreUriStringtos-vn-437**/example.mp4存储地址。
VideoStreamMetaObject of VideoStreamMeta-视频流信息。
AudioStreamMetaObject of AudioStreamMeta-音频流信息。
CreateTimeString2023-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:采样截图
PosterObject of Poster-静态图。
DynpostObject of Dynpost-动图。
AnimatedPosterObject of AnimatedPoster-反复循环动图。
AIDynpostObject of AIDynpost-AI 动图。
SpriteObject of Sprite-雪碧图。
SampleObject of Sample-采样截图。

VideoStreamMeta

参数类型示例值描述
CodecStringh264视频编码格式。
HeightInteger1080视频高度,单位为 px。
WidthInteger840视频宽度,单位为 px。
DurationFloat12视频时长,单位为 s。
DefinitionString1080p视频清晰度。
BitrateInteger32034视频码率,单位为 bps。
FpsFloat30帧率。

AudioStreamMeta

参数类型示例值描述
CodecStringaac音频编码格式。
DurationFloat15音频时长,单位为 s。
SampleRateInteger44100音频采样率。
BitrateInteger3443音频码率,单位为 bps。

Quality

String

higher

音频质量。取值如下:

  • higher:高音质。
  • highest:音乐音质。
  • medium:普通音质。
ChannelsInteger4声道数。

Poster

参数类型示例值描述
FormatStringjpeg截图格式。
StoreUriStringtos***/cbe797357ecf439***c4a26b69dd5存储地址。
WidthInteger360截图宽度,单位为 px。
HeightInteger640截图高度,单位为 px。

Dynpost

参数类型示例值描述
FormatStringgif截图格式。
StoreUriStringtos***/c5d95e55fdbb***62c8c5f7e4a6aa存储地址。
WidthInteger360截图宽度,单位为 px。
HeightInteger640截图高度,单位为 px。

AnimatedPoster

参数类型示例值描述
FormatStringwebp截图格式。
StoreUriStringtos***/89523e5554a74***9c6898761055a8存储地址。
WidthInteger540截图宽度,单位为 px。
HeightInteger960截图高度,单位为 px。

AIDynpost

参数类型示例值描述
FormatStringwebp截图格式。
StoreUriStringtos***/89523e5554a74***9c6898761055a8存储地址。
WidthInteger540截图宽度,单位为 px。
HeightInteger960截图高度,单位为 px。

Sprite

参数类型示例值描述
FormatStringjpeg截图格式。
StoreUrisArray of Stringtos***/14437a144eb14***38b8b731f8a96存储地址。
CellWidthInteger240小图宽度,单位为 px。
CellHeightInteger360小图高度,单位为 px。
ImgXLenInteger5水平方向小图个数。
ImgYLenInteger5垂直方向小图个数。
IntervalFloat10截图间隔,单位为 s。
CaptureNumInteger1截图张数。

Sample

参数类型示例值描述
FormatStringjpeg截图格式。

StoreUris

Array of String

["tos***/fd5856116d7c45***906f37fabee"]

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

说明

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

WidthInteger540截图宽度,单位为 px。
HeightInteger960截图高度,单位为 px。
IntervalFloat10截图间隔,单位为 s。
CaptureNumInteger1截图张数。
DurationFloat14记录各个截图的时间点,默认会升序排序输出。

IndexUri

String

{"StoreUri": "xxx/uri1", "Offset": [2.5]}

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

说明

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

请求示例

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 各语言调用的示例代码,请参考如下: