遍历媒体工作流执行实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mts:ListMediaWorkflowExecutions |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| MediaWorkflowId |
string |
否 |
需要查询实例的媒体工作流 ID。可以通过 MPS 控制台 > 工作流管理 > 工作流设置获取。 |
43b7335a4b1d4fe883670036affb**** |
| MediaWorkflowName |
string |
否 |
媒体工作流名称。可以通过 MPS 控制台 > 工作流管理 > 工作流设置获取。 |
example-mediaworkflow-**** |
| InputFileURL |
string |
否 |
媒体工作流指定的输入文件 OSS Bucket。遵循 RFC 3986(UTF8 编码,并对保留字符进行 URLEncode)。更多信息,请参见 URLEncode 说明。 |
http://example-****.cn-hangzhou.aliyuncs.com/test****.flv |
| NextPageToken |
string |
否 |
下一页标识,32 位 UUID。请求第一页时,NextPageToken 为空;请求后续文件时需传入前一页查询结果中的 NextPageToken 值。 |
39f8e0bc005e4f309379701645f4**** |
| MaximumPageSize |
integer |
否 |
最大可返回的媒体工作流执行实例数。取值范围: |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| MediaWorkflowExecutionList |
object |
||
| MediaWorkflowExecution |
array<object> |
媒体工作流列表。 |
|
|
array<object> |
详细信息。 |
||
| CreationTime |
string |
创建时间。 |
2016-04-01T06:53:43Z |
| MediaWorkflowId |
string |
媒体工作流 ID。 |
43b7335a4b1d4fe883670036affb**** |
| State |
string |
工作流状态。可取值:
说明
Completed 仅表示工作流执行完成,每个活动(转码、截图等)是否成功要看每个活动具体的状态值。
|
Success |
| ActivityList |
object |
||
| Activity |
array<object> |
媒体工作流活动列表。 |
|
|
array<object> |
详细信息。 |
||
| EndTime |
string |
活动结束执行时间。 |
2016-04-01T06:54:00Z |
| Type |
string |
媒体工作流活动类型。可取值:Start 活动、Snapshot 活动、Transcode 活动、Analysis 活动、Report 活动。更多信息请参见媒体工作流活动介绍。 |
Start |
| StartTime |
string |
活动开始执行时间。 |
2016-04-01T06:53:45Z |
| State |
string |
活动状态。可取值:
说明
例如:分析活动之后有高清、标清两个转码活动,会根据实际分析的结果来决策,如果原视频内容清晰度不够,高清的转码活动就可能被跳过。 |
Success |
| JobId |
string |
活动执行时生成的作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。 |
2376030d9d0849399cd20e20c876**** |
| Code |
string |
错误码。
|
null |
| Message |
string |
错误信息。
|
null |
| Name |
string |
媒体工作流活动名称。 说明
在同一个工作流中活动的名称是唯一的。 |
Act-2 |
| MNSMessageResult |
object |
MNS 通知用户作业完成结果。 |
|
| MessageId |
string |
执行成功时消息 ID。如果执行失败则不返回此参数。 |
4f3bc83233de4e2f81c7dade443e**** |
| ErrorMessage |
string |
执行失败时错误信息。如果执行成功则不返回此参数。 |
MessageConfigEmpty |
| ErrorCode |
string |
执行失败时错误码。如果执行成功则不返回此参数。 |
The Topic/Queue config is empty, not send message |
| Name |
string |
媒体工作流名称。 |
example-mediaworkflow-**** |
| Input |
object |
媒体工作流的用户自定义数据。 |
|
| UserData |
string |
用户自定义数据。 |
example data |
| InputFile |
object |
媒体工作流的输入 OSS Bucket。 |
|
| Object |
string |
输入文件的 OSS Object。 |
example-mediaWorkflow-****/example-object-****/example.mp4 |
| Location |
string |
输入文件的 OSS Location。 |
cn-shanghai |
| Bucket |
string |
输入文件的 OSS Bucket。 |
example-bucket-**** |
| MediaId |
string |
媒体 ID。媒体工作流生成的所有信息都属于这个媒体 ID。 |
512046582a924698a41e0f8b0d2b**** |
| RunId |
string |
执行实例 ID。 |
48e33690ac19445488c706924321**** |
| RequestId |
string |
请求 ID。 |
D1D5C080-8E2F-5030-8AB4-13092F17631B |
| NextPageToken |
string |
下一页标识。 |
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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。