文档

ListMediaWorkflowExecutions - 遍历媒体工作流执行实例

更新时间:

遍历媒体工作流执行实例。

接口说明

本接口只返回近 90 天执行实例。

QPS 限制

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

调试

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

授权信息

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

请求参数

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

需要查询实例的媒体工作流 ID。可以通过 MPS 控制台 > 工作流管理 > 工作流设置获取。

43b7335a4b1d4fe883670036affb****
MediaWorkflowNamestring

媒体工作流名称。可以通过 MPS 控制台 > 工作流管理 > 工作流设置获取。

example-mediaworkflow-****
InputFileURLstring

媒体工作流指定的输入文件 OSS Bucket。遵循 RFC 3986(UTF8 编码,并对保留字符进行 URLEncode)。更多信息,请参见 URLEncode 说明

http://example-****.cn-hangzhou.aliyuncs.com/test****.flv
NextPageTokenstring

下一页标识,32 位 UUID。请求第一页时,NextPageToken 为空;请求后续文件时需传入前一页查询结果中的 NextPageToken 值。

39f8e0bc005e4f309379701645f4****
MaximumPageSizelong

最大可返回的媒体工作流执行实例数。取值范围:[1,100],默认值:10

1

返回参数

名称类型描述示例值
object

返回参数。

MediaWorkflowExecutionListobject []

媒体工作流列表。

CreationTimestring

创建时间。

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

媒体工作流 ID。

43b7335a4b1d4fe883670036affb****
Statestring

工作流状态。可取值:

  • Running:执行中。

  • Completed:执行完成。

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

  • Success:执行成功。

Success
ActivityListobject []

媒体工作流活动列表。

EndTimestring

活动结束执行时间。

2016-04-01T06:54:00Z
Typestring

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

Start
StartTimestring

活动开始执行时间。

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

活动状态。可取值:

  • Running:活动执行中。

  • Fail:活动执行失败。

  • Skipped:活动被跳过。

  • Success:执行成功。

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

活动执行时生成的作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。

2376030d9d0849399cd20e20c876****
Codestring

错误码。

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

  • 如果活动状态是 Success,此参数不返回。

null
Messagestring

错误信息。

  • 如果活动状态是 Fail,会给出详细的错误描述信息。
  • 如果活动状态是 Success,此参数不返回。
null
Namestring

媒体工作流活动名称。

说明 在同一个工作流中活动的名称是唯一的。
Act-2
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

媒体工作流的输入 OSS Bucket。

Objectstring

输入文件的 OSS Object。

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

输入文件的 OSS Location。

cn-shanghai
Bucketstring

输入文件的 OSS Bucket。

example-bucket-****
MediaIdstring

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

512046582a924698a41e0f8b0d2b****
RunIdstring

执行实例 ID。

48e33690ac19445488c706924321****
RequestIdstring

请求 ID。

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

下一页标识。

39f8e0bc005e4f309379701645f4****

示例

正常返回示例

JSON格式

{
  "MediaWorkflowExecutionList": {
    "MediaWorkflowExecution": [
      {
        "CreationTime": "2016-04-01T06:53:43Z",
        "MediaWorkflowId": "43b7335a4b1d4fe883670036affb****",
        "State": "Success",
        "ActivityList": {
          "Activity": [
            {
              "EndTime": "2016-04-01T06:54:00Z",
              "Type": "Start",
              "StartTime": "2016-04-01T06:53:45Z",
              "State": "Success",
              "JobId": "2376030d9d0849399cd20e20c876****",
              "Code": "null",
              "Message": "null",
              "Name": "Act-2",
              "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": "cn-shanghai",
            "Bucket": "example-bucket-****"
          }
        },
        "MediaId": "512046582a924698a41e0f8b0d2b****",
        "RunId": "48e33690ac19445488c706924321****"
      }
    ]
  },
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B",
  "NextPageToken": "39f8e0bc005e4f309379701645f4****"
}

错误码

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

变更历史

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