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