文档

QueryMediaWorkflowExecutionList - 查询媒体工作流执行实例

更新时间:

查询媒体工作流执行实例。

接口说明

  • 本接口一次最多查询 10 个媒体工作流执行实例。
  • 请确保工作流中使用的管道为开启状态,否则可能会导致工作流无法正常使用(比如:工作流节点显示已失效、工作流状态一直卡在已提交等)。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

媒体工作流执行实例 ID 列表,可以通过 MPS 控制台 > 工作流管理 > 执行实例获取。使用半角逗号(,)分隔,一次最多查询 10 个。

48e33690ac19445488c706924321****

返回参数

名称类型描述示例值
object

返回参数。

NonExistRunIdsarray

不存在的媒体工作流实例列表。

string

不存在的执行实例 ID。如果没有则此参数不返回。

null
MediaWorkflowExecutionListobject []

媒体工作流列表。

CreationTimestring

创建时间。

016-04-01T06:53:43Z
MediaWorkflowIdstring

媒体工作流 ID。

93ab850b4f6f44eab54b6e91****81d4
Statestring

状态。取值:

  • Running:执行中。

  • Completed:执行完成。

说明 Completed 仅表示工作流执行完成,每个活动的(转码、截图等)是否成功要看每个活动具体的状态值。
  • Fail:执行失败。
Completed
ActivityListobject []

媒体工作流活动列表。

EndTimestring

活动结束执行时间。

2016-04-01T06:53:44Z
Typestring

媒体工作流活动类型。可取值:Start 活动、Snapshot 活动、Transcode 活动、Analysis 活动、Report 活动。更多活动信息请参见媒体工作流活动介绍

Start
StartTimestring

活动开始执行时间。

2016-04-01T06:53:44Z
Statestring

状态。取值:

  • Running:活动执行中。

  • Success:活动执行成功。

  • Fail:活动执行失败。

  • Skipped:活动被跳过。

说明 例如:分析活动之后有高清、标清两个转码活动,会根据实际分析的结果来决策,如果原视频内容清晰度不够,高清的转码活动就可能被跳过。
Running
JobIdstring

活动执行时生成的作业 ID(例如分析作业 ID、转码作业 ID、截图作业 ID)。

2376030d9d0849399cd20e20f4f3****
Codestring

错误码。

  • 当活动状态是 Fail 时,会给出具体的错误码。

  • 当活动状态是 Success 时,不返回此参数。

InvalidParameter.ResourceContentBad
Messagestring

错误信息。

  • 当活动状态是 Fail 时,会给出详细的错误描述信息。

  • 当活动状态是 Success 时,此参数不返回。

The resource operated InputFile is bad
Namestring

媒体工作流活动名称。

说明 在同一个工作流中活动的名字是唯一的。
Start
MNSMessageResultobject

MNS 通知用户作业完成结果。

MessageIdstring

执行成功时消息的 ID。如果执行失败则不返回此参数。

4f3bc83233de4e2f81c7dade443e****
ErrorMessagestring

执行失败时错误信息。如果执行成功则不返回此参数。

MessageConfigEmpty
ErrorCodestring

执行失败时错误码。如果执行成功则不返回此参数。

The Topic/Queue config is empty, not send message
Namestring

媒体工作流名称。

example-mediaworkflow-****
Inputobject

媒体工作流的用户自定义数据。

UserDatastring

用户自定义数据。

example data ****
InputFileobject

媒体工作流的输入文件。

Objectstring

输入文件的 OSS Object。

example-mediaWorkflow-****/example-object-****/example.mp4
Locationstring

输入文件的 OSS Location。

mps-cn-shanghai
Bucketstring

输入文件的 OSS Bucket。

example-bucket-****
MediaIdstring

媒体 ID。媒体工作流生成的所有信息都属于这个媒体 ID。

512046582a924698a41e0f8b0d2b****
RunIdstring

执行实例 ID。

48e33690ac19445488c706924321****
RequestIdstring

请求 ID。

D1D5C080-8E2F-5030-8AB4-13092F17631B

示例

正常返回示例

JSON格式

{
  "NonExistRunIds": {
    "RunId": [
      "null"
    ]
  },
  "MediaWorkflowExecutionList": {
    "MediaWorkflowExecution": [
      {
        "CreationTime": "016-04-01T06:53:43Z",
        "MediaWorkflowId": "93ab850b4f6f44eab54b6e91****81d4",
        "State": "Completed",
        "ActivityList": {
          "Activity": [
            {
              "EndTime": "2016-04-01T06:53:44Z",
              "Type": "Start",
              "StartTime": "2016-04-01T06:53:44Z",
              "State": "Running",
              "JobId": "2376030d9d0849399cd20e20f4f3****",
              "Code": "InvalidParameter.ResourceContentBad",
              "Message": "The resource operated InputFile is bad",
              "Name": "Start",
              "MNSMessageResult": {
                "MessageId": "4f3bc83233de4e2f81c7dade443e****",
                "ErrorMessage": "MessageConfigEmpty",
                "ErrorCode": "The Topic/Queue config is empty, not send message"
              }
            }
          ]
        },
        "Name": "example-mediaworkflow-****",
        "Input": {
          "UserData": "example data ****",
          "InputFile": {
            "Object": "example-mediaWorkflow-****/example-object-****/example.mp4",
            "Location": "mps-cn-shanghai",
            "Bucket": "example-bucket-****"
          }
        },
        "MediaId": "512046582a924698a41e0f8b0d2b****",
        "RunId": "48e33690ac19445488c706924321****"
      }
    ]
  },
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈