调用ListFlowInstance接口，查询工作流实例列表。

调试

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

调试

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
Action String 是 ListFlowInstance

系统规定参数。取值：ListFlowInstance。
ProjectId String 是 FP-7A1018ADE917****

项目ID。您可以调用ListFlowProject查看项目的ID。

RegionId String 是 cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Id String 否 无

保留字段。
FlowId String 否 F-1B4018ADE917****

工作流ID。您可以调用ListFlowInstance查看工作流ID。

FlowName String 否 my_flow

工作流名称。
Owner String 否 1230404****

责任人ID。
InstanceId String 否 FI-7CAF9709CD32****

工作流实例ID。您可以调用ListFlowInstance查看工作流实例ID。

NodeInstanceId String 否 FJI-54FEBB063136****

作业实例ID。您可以调用DescribeFlowJob查看作业实例ID。

TimeRange String 否 {"type": "range", "from": 1608263168000, "to": 1608263169000}

查询的时间范围参数，参数列表：

  • type：range
  • from：开始时间（long型）
  • to： 结束时间（long型）
StatusList.N RepeatList 否 RUNNING

工作流状态：

  • PREP：准备中
  • RUNNING：运行中
  • SUCCEEDED：成功
  • FAILED：失败
  • KILLED：已终止
  • SUSPENDED：暂停中
OrderBy String 否 id

排序字段名称。
OrderType String 否 ASC

排序方向：

  • ASC：升序排列
  • DESC：降序排列
PageNumber Integer 否 1

页码。
PageSize Integer 否 20

每页数量。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
FlowInstances Array of FlowInstance

工作流实例列表。
FlowInstance
ClusterId String C-F32FB31D8295****

集群ID。
Duration Long 12000

运行持续时间，单位ms。
EndTime Long 1540796248000

运行结束时间。
FlowId String F-35683D0E4573****

工作流ID。
FlowName String flow-hive

工作流名称。
GmtCreate Long 1540796248000

创建时间。
GmtModified Long 1540796248000

修改时间。
HasNodeFailed Boolean false

已经过期。
Id String FI-7CAF9709CD32****

工作流实例ID。
Owner String ****

责任人ID。
ProjectId String FP-7A1018ADE917****

项目ID。
ScheduleTime Long 1554110977000

任务调度时间。
StartTime Long 1540796236000

运行开始时间。
Status String SUCCEEDED

工作流状态：

  • PREP：准备中
  • RUNNING：运行中
  • SUCCEEDED：成功
  • FAILED：失败
  • KILLED：已终止
  • SUSPENDED：暂停中
PageNumber Integer 1

页码。
PageSize Integer 20

每页数量。
RequestId String EDF99BA3-F7AF-49B2-ABA1-36430A31F482

请求ID。
Total Integer 42

总数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlowInstance
&ProjectId=FP-7A1018ADE917****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<FlowInstances>
    <FlowInstance>
        <Status>FAILED</Status>
        <FlowId>F-9C8D2BEC4D38****</FlowId>
        <Owner>125046002175****</Owner>
        <GmtCreate>1542963000000</GmtCreate>
        <EndTime>1542963033000</EndTime>
        <ClusterId>C-A6C9F4F1E9EC****</ClusterId>
        <FlowName>success+fail</FlowName>
        <StartTime>1542963001000</StartTime>
        <ProjectId>FP-17AB3389E1AD****</ProjectId>
        <GmtModified>1542963033000</GmtModified>
        <Duration>32000</Duration>
        <Id>FI-03F019530CB8****</Id>
    </FlowInstance>
    <FlowInstance>
        <Status>SUCCEEDED</Status>
        <FlowId>F-FECA99A4AE79****</FlowId>
        <Owner>20538903898346****</Owner>
        <GmtCreate>1542963000000</GmtCreate>
        <EndTime>1542963015000</EndTime>
        <ClusterId>C-A6C9F4F1E9EC****</ClusterId>
        <FlowName>success</FlowName>
        <StartTime>1542963000000</StartTime>
        <ProjectId>FP-17AB3389E1AD****</ProjectId>
        <GmtModified>1542963015000</GmtModified>
        <Duration>15000</Duration>
        <Id>FI-60B9DBFA5AD2****</Id>
    </FlowInstance>
</FlowInstances>
<PageSize>2</PageSize>
<RequestId>780BB15A-9038-4330-BE6C-0A47FE5A1BBF</RequestId>
<PageNumber>1</PageNumber>
<Total>50</Total>

JSON格式 

{
    "FlowInstances": {
        "FlowInstance": [
            {
                "Status": "FAILED",
                "FlowId": "F-9C8D2BEC4D38****",
                "Owner": "125046002175****",
                "GmtCreate": 1542963000000,
                "EndTime": 1542963033000,
                "ClusterId": "C-A6C9F4F1E9EC****",
                "FlowName": "success+fail",
                "StartTime": 1542963001000,
                "ProjectId": "FP-17AB3389E1AD****",
                "GmtModified": 1542963033000,
                "Duration": 32000,
                "Id": "FI-03F019530CB8****"
            },
            {
                "Status": "SUCCEEDED",
                "FlowId": "F-FECA99A4AE79****",
                "Owner": "20538903898346****",
                "GmtCreate": 1542963000000,
                "EndTime": 1542963015000,
                "ClusterId": "C-A6C9F4F1E9EC****",
                "FlowName": "success",
                "StartTime": 1542963000000,
                "ProjectId": "FP-17AB3389E1AD****",
                "GmtModified": 1542963015000,
                "Duration": 15000,
                "Id": "FI-60B9DBFA5AD2****"
            }
        ]
    },
    "PageSize": 2,
    "RequestId": "780BB15A-9038-4330-BE6C-0A47FE5A1BBF",
    "PageNumber": 1,
    "Total": 50
}