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

调试

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

请求参数

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

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

ProjectId String FP-7A1018ADE9179EE1

项目ID。

RegionId String cn-hangzhou

地域ID。

FlowId String F-1B4018ADE9179EE1

工作流ID。

FlowName String my_flow

工作流名称。

Id String x

已过期。

InstanceId String FI-7CAF9709CD328EBE

工作流实例ID。

OrderBy String id

排序字段名称。

OrderType String asc

排序方向:ASC/DESC。

Owner String 1230404****

责任人ID。

PageNumber Integer 1

页码。

PageSize Integer 20

每页数量。

StatusList.N RepeatList RUNNING

状态列表。

TimeRange String {"type":"date","date":"ALL"}

查询时间范围。

返回数据

名称 类型 示例值 描述
FlowInstances

工作流实例列表。

FlowInstance

工作流实例列表。

ClusterId String C-F32FB31D82954C64

集群ID。

Duration Long 12000

运行持续时间,单位ms

EndTime Long 1540796248000

运行结束时间。

FlowId String F-35683D0E45734E34

工作流ID。

FlowName String flow-hive

工作流名称。

GmtCreate Long 1540796248000

创建时间。

GmtModified Long 1540796248000

修改时间。

HasNodeFailed Boolean false

已经过期。

Id String FI-7CAF9709CD328EBE

工作流实例ID。

Owner String ****

责任人ID。

ProjectId String FP-7A1018ADE9179EE1

项目ID。

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-7A1018ADE9179EE1
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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