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

调试

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

请求参数

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

系统规定参数。取值：ListFlowInstance。

Id String 否 无

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

工作流ID。您可以调用ListFlowInstance查看工作流ID。
FlowName String 否 my_flow

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

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

工作流实例ID。您可以调用ListFlowInstance查看工作流实例ID。
TimeRange String 否 {"type": "range", "from": 1608263168000, "to": 1608263169000}

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

  • type：range
  • from：开始时间（long型）
  • to：结束时间（long型）
OrderBy String 否 id

排序字段名称。
OrderType String 否 ASC

排序方向：

  • ASC：升序排列
  • DESC：降序排列
RegionId String 是 cn-hangzhou

地域ID。
ProjectId String 是 FP-7A1018ADE917****

项目ID。您可以调用ListFlowProjects查看项目的ID。
PageNumber Integer 否 1

页码。
PageSize Integer 否 20

每页数量。
StatusList.N String 否 RUNNING

工作流状态：

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

返回数据

名称 类型 示例值 描述
RequestId String EDF99BA3-F7AF-49B2-ABA1-36430A31F482

请求ID。
PageNumber Integer 1

页码。
PageSize Integer 20

每页数量。
Total Integer 53

总数。
FlowInstances Array of FlowInstance

工作流实例列表。
FlowInstance
Status String SUCCEEDED

工作流状态：

  • PREP：准备中
  • RUNNING：运行中
  • SUCCEEDED：成功
  • FAILED：失败
  • KILLED：已终止
  • SUSPENDED：暂停中
Owner String 1230404****

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

项目ID。
FlowName String flow-spark

工作流名称。
GmtModified Long 1540796248000

变更时间。
FlowId String F-35683D0E4573****

工作流ID。
EndTime Long 1540796248000

运行结束时间。
StartTime Long 1540796236000

运行开始时间。
HasNodeFailed Boolean false

已经过期。
GmtCreate Long 1540796248000

创建时间。
ScheduleTime Long 1554110977000

任务调度时间。
Duration Long 12000

运行持续时间，单位ms。
Id String FI-7CAF9709CD32****

工作流实例ID。
ClusterId String C-F32FB31D8295****

集群ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlowInstance
&Id=无
&FlowId=F-1B4018ADE917****
&FlowName=my_flow
&Owner=1230404****
&InstanceId=FI-7CAF9709CD32****
&TimeRange={"type": "range", "from": 1608263168000, "to": 1608263169000}
&OrderBy=id
&OrderType=ASC
&RegionId=cn-hangzhou
&ProjectId=FP-7A1018ADE917****
&PageNumber=1
&PageSize=20
&StatusList=["RUNNING"]
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFlowInstanceResponse>
    <RequestId>EDF99BA3-F7AF-49B2-ABA1-36430A31F482</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <Total>53</Total>
    <FlowInstances>
        <Status>SUCCEEDED</Status>
        <Owner>1230404****</Owner>
        <ProjectId>FP-7A1018ADE917****</ProjectId>
        <FlowName>flow-spark</FlowName>
        <GmtModified>1540796248000</GmtModified>
        <FlowId>F-35683D0E4573****</FlowId>
        <EndTime>1540796248000</EndTime>
        <StartTime>1540796236000</StartTime>
        <HasNodeFailed>false</HasNodeFailed>
        <GmtCreate>1540796248000</GmtCreate>
        <ScheduleTime>1554110977000</ScheduleTime>
        <Duration>12000</Duration>
        <Id>FI-7CAF9709CD32****</Id>
        <ClusterId>C-F32FB31D8295****</ClusterId>
    </FlowInstances>
</ListFlowInstanceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "EDF99BA3-F7AF-49B2-ABA1-36430A31F482",
  "PageNumber" : 1,
  "PageSize" : 20,
  "Total" : 53,
  "FlowInstances" : [ {
    "Status" : "SUCCEEDED",
    "Owner" : "1230404****",
    "ProjectId" : "FP-7A1018ADE917****",
    "FlowName" : "flow-spark",
    "GmtModified" : 1540796248000,
    "FlowId" : "F-35683D0E4573****",
    "EndTime" : 1540796248000,
    "StartTime" : 1540796236000,
    "HasNodeFailed" : false,
    "GmtCreate" : 1540796248000,
    "ScheduleTime" : 1554110977000,
    "Duration" : 12000,
    "Id" : "FI-7CAF9709CD32****",
    "ClusterId" : "C-F32FB31D8295****"
  } ]
}

错误码

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

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