You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒体处理/获取工作流运行状态
获取工作流运行状态
最近更新时间：2024.06.24 19:42:58首次发布时间：2022.09.23 17:49:27
我的收藏

此接口用于指定 RunId 工作流任务 ID，获取工作流运行状态。

注意事项

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

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetWorkflowExecution&Version=2020-08-01

调试

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

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
是
GetWorkflowExecution
接口名称。当前 API 的名称为 GetWorkflowExecution。
Version
String
是
2020-08-01
接口版本。当前 API 的版本为 2020-08-01。
RunId
String
是
fershg899***
工作流任务 ID。用于唯一指示当前这次转码事件。可通过触发工作流接口获取。

返回参数

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

参数
类型
示例值
描述
RunId
String
2ce437f301a9***cf80b5369fe4
工作流任务 ID。
Vid
String
v0c931g7007ac***833096m05os10
视频 ID。
DirectUrl
Object
-
DirectUrl 模式下文件存储路径。
FileName
String
example.mp4
文件路径。
BucketName
String
YourBucketName
存储桶名称。
TemplateId
String
3447e8db6***6271401b132a455
工作流模板 ID。
SpaceName
String
test
点播空间名称。
TemplateName
String
模板组-hls
工作流模板名称。
Status
String
0

执行状态。取值如下：

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

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

    说明

    具体详见工作流状态码。

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

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

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

    • Terminated：终止。
EnableLowPriority
Boolean
true

是否为闲时任务。取值如下：

  • false：正常任务。
  • true：闲时任务。
JobSource
String
API

任务来源。取值如下：

  • API：主动触发。
  • AutoTrigger：自动触发。
  • TranscodeStrategy：策略触发。
  • SystemTrigger：系统触发。
CreateTime
String
2022-08-29T03:30:04Z
创建时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
StartTime
String
2022-08-29T04:46:22Z
开始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime
String
2022-08-29T04:46:22Z
结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。

请求示例

https://vod.volcengineapi.com?Action=GetWorkflowExecution&Version=2020-08-01&RunId=fershg899***

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022090515143***2551810746A0D7",
    "Action": "GetWorkflowExecution",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "RunId": "2ce437f301a9***cf80b5369fe4",
    "Vid": "v0c931g7007ac***833096m05os10",
    "TemplateId": "3447e8db6***6271401b132a455",
    "TemplateName": "模板组-hls",
    "SpaceName": "000000",
    "Status": "0",
    "TaskListId": "87f133ea9b***d3058335f673",
    "JobSource": "API",
    "CreateTime": "2022-08-29T03:30:04Z",
    "StartTime": "2022-08-29T04:46:22Z",
    "EndTime": "2022-08-29T04:46:22Z",
    "EnableLowPriority": true
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码错误码错误信息说明
400InvalidParameter-非法参数。
403RequestForbidden-非法请求。
404ResourceNotFound-ID 找不到。
409ResourceInUse-ID 正在被使用（删除时）。
429RequestLimitExceeded-请求超过上限。
500InternalError-内部错误。
503ServiceUnavailable-服务不可用。

服务端 SDK

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