調用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****"
  } ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

訪問錯誤中心查看更多錯誤碼。