You can call this operation to view the details of a workflow instance.

Request parameters

Name Type Required Example Description
Type String Yes FLOW The type of the category. Valid values: FLOW, JOB, and ADHOC.
ProjectId String Yes FP-ABD24A6163D31274 The ID of the project.
RegionId String Yes cn-hangzhou The ID of the region.

Response parameters

Name Type Example Description
RequestId String EDF99BA3-F7AF-49B2-ABA1-36430A31F482 The ID of the request.
Id String F-String The ID of the workflow instance.
GmtCreate Long 1540796248000 The creation time.
GmtModified Long 1540796248000 The modification time.
FlowId String F-35683D0E45734E34 The ID of the workflow.
FlowName String flow-hive The name of the workflow.
ProjectId String FP-7A1018ADE9179EE1 The ID of the project.
Status String SUCCEEDED The status of the workflow instance. Valid values: PREP, RUNNING, SUCCEEDED, FAILED, KILLED, and SUSPENDED.
ClusterId String C-F32FB31D82954C64 The ID of the cluster.
StartTime Long 1540796236000 The time when the workflow instance starts running.
EndTime Long 1540796248000 The time when the workflow instance ends running.
Duration Long 12,000 The running duration. Unit: milliseconds.
Graph String {"nodes":[{"shape":"startControlNode","size":"80*34","spmAnchorId":"0.0.0.i0.766645eb2cmNtQ","x":500,"y":250,"index":0,"id":"48d474ea","attribute":{"type":"START"},"type":"node"},{"shape":"hiveSQLJobNode","size":"170*34","spmAnchorId":"5176.8250060.0.i11.499128d0KWdQvq","x":515,"y":334.5,"index":1,"id":"2f089966","label":"hive-test","attribute":{"jobId":"FJ-C6C794219DE652B9","type":"JOB","jobType":"HIVE_SQL"},"type":"node","config":{"hostName":"","clusterId":""}},{"shape":"endControlNode","size":"80*34","spmAnchorId":"5176.8250060.0.i15.499128d0KWdQvq","x":532,"y":453.5,"index":2,"id":"ac092a54","attribute":{"type":"END"},"type":"node"}],"edges":[{"sourceAnchor":0,"targetAnchor":0,"index":3,"source":"48d474ea","id":"77e6117c","target":"2f089966"},{"sourceAnchor":1,"targetAnchor":0,"index":4,"source":"2f089966","id":"95ba3716","target":"ac092a54"}]} The graphical information of the workflow.
NodeInstance The node instances of the workflow instance.
Id String FNI-9D14A7CCF2687B84 The ID of the node instance.
GmtCreate Long 1540796236000 The creation time.
GmtModified Long 1540796247000 The modification time.
Type String JOB The type of the node. Valid values: JOB, CLUSTER, START, and END.
Status String OK The status of the workflow instance. Valid values: PREP, SUBMITTING, RUNNING, DONE, OK, FAILED, KILLED, KILL_FAILED, and START_RETRY.
JobId String FJ-C6C794219DE652B9 The ID of the corresponding job.
JobName String hive-test The name of the corresponding job.
JobType String HIVE_SQL The type of the corresponding job.
FailAct String STOP The action to take after failure. Valid values: STOP and CONTINUE.
MaxRetry String 0 The maximum number of retries.
RetryInterval String 15 The interval between retries. Unit: seconds.
NodeName String 2f089966 The name of the node.
ClusterId String C-F32FB31D82954C64 The ID of the cluster.
HostName String emr-header-1.cluster-12345 The hostname of the host on which the workflow node instance runs. Only master nodes and gateways are supported. You can use the hostname command to view the hostname of the host that you want for running the workflow node instance.
ProjectId String FP-7A1018ADE9179EE1 The ID of the project.
Pending Boolean true Indicates whether the workflow instance is terminated.
StartTime Long 1540796237000 The time when the workflow instance starts running.
EndTime Long 1540796248000 The time when the workflow instance ends running.
Duration Long 11,000 The running duration.
Retries Integer 0 The number of retries.
ExternalId String application_1540362938289_1858 The external ID. For example, the application ID of the launcher.
ExternalStatus String SUCCESS The external status. Valid values: SUBMITTED, RUNNING, SUCCESS, FAIL, KILL_FAIL, and KILL_SUCCESS.
ExternalInfo String empty The external information. For example, the diagnostic information of a job running error.

Examples

  • Sample requests
    
    /? Action=DescribeFlowInstance
    &Id=FI-7CAF9709CD328EBE
    &ProjectId=FP-7A1018ADE9179EE1
    &RegionId=cn-hangzhou
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"code":"200",
    	"data":{
    		"ClusterId":"C-F32FB31D82954C64",
    		"Duration":12000,
    		"EndTime":1540796248000,
    		"FlowId":"F-35683D0E45734E34",
    		"FlowName":"flow-hive",
    		"GmtCreate":1540796235000,
    		"GmtModified":1540796247000,
    		"Graph":{
    			"edges":[
    				{
    					"id":"77e6117c",
    					"index":3,
    					"source":"48d474ea",
    					"sourceAnchor":0,
    					"target":"2f089966",
    					"targetAnchor":0
    				},
    				{
    					"id":"95ba3716",
    					"index":4,
    					"source":"2f089966",
    					"sourceAnchor":1,
    					"target":"ac092a54",
    					"targetAnchor":0
    				}
    			],
    			"nodes":[
    				{
    					"attribute":{
    						"type":"START"
    					},
    					"id":"48d474ea",
    					"index":0,
    					"shape":"startControlNode",
    					"size":"80*34",
    					"spmAnchorId":"0.0.0.i0.766645eb2cmNtQ",
    					"type":"node",
    					"x":500,
    					"y":250
    				},
    				{
    					"attribute":{
    						"jobId":"FJ-C6C794219DE652B9",
    						"jobType":"HIVE_SQL",
    						"type":"JOB"
    					},
    					"config":{
    						"clusterId":"",
    						"hostName":""
    					},
    					"id":"2f089966",
    					"index":1,
    					"label":"hive-test",
    					"shape":"hiveSQLJobNode",
    					"size":"170*34",
    					"spmAnchorId":"5176.8250060.0.i11.499128d0KWdQvq",
    					"type":"node",
    					"x":515,
    					"y":334.5
    				},
    				{
    					"attribute":{
    						"type":"END"
    					},
    					"id":"ac092a54",
    					"index":2,
    					"shape":"endControlNode",
    					"size":"80*34",
    					"spmAnchorId":"5176.8250060.0.i15.499128d0KWdQvq",
    					"type":"node",
    					"x":532,
    					"y":453.5
    				}
    			]
    		},
    		"Id":"FI-7CAF9709CD328EBE",
    		"NodeInstance":{
    			"NodeInstance":[
    				{
    					"ClusterId":"C-F32FB31D82954C64",
    					"Duration":0,
    					"EndTime":1540796236000,
    					"FailAct":"STOP",
    					"GmtCreate":1540796236000,
    					"GmtModified":1540796236000,
    					"HostName":"",
    					"Id":"FNI-1286C1ED46C4577A",
    					"MaxRetry":"0",
    					"NodeName":":start:",
    					"Pending":false,
    					"ProjectId":"FP-7A1018ADE9179EE1",
    					"Retries":0,
    					"StartTime":1540796236000,
    					"Status":"OK",
    					"Type":"START"
    				},
    				{
    					"ClusterId":"C-F32FB31D82954C64",
    					"Duration":11000,
    					"EndTime":1540796248000,
    					"ExternalId":"application_1540362938289_1858",
    					"ExternalInfo":"",
    					"ExternalStatus":"SUCCESS",
    					"FailAct":"STOP",
    					"GmtCreate":1540796236000,
    					"GmtModified":1540796247000,
    					"HostName":"emr-header-1.cluster-500159692",
    					"Id":"FNI-9D14A7CCF2687B84",
    					"JobId":"FJ-C6C794219DE652B9",
    					"JobName":"hive-test",
    					"JobType":"HIVE_SQL",
    					"MaxRetry":"0",
    					"NodeName":"2f089966",
    					"Pending":false,
    					"ProjectId":"FP-7A1018ADE9179EE1",
    					"Retries":0,
    					"RetryInterval":"15",
    					"StartTime":1540796237000,
    					"Status":"OK",
    					"Type":"JOB"
    				},
    				{
    					"ClusterId":"C-F32FB31D82954C64",
    					"Duration":0,
    					"EndTime":1540796248000,
    					"FailAct":"STOP",
    					"GmtCreate":1540796247000,
    					"GmtModified":1540796247000,
    					"HostName":"",
    					"Id":"FNI-14C14E312AF94FB8",
    					"MaxRetry":"0",
    					"NodeName":"ac092a54",
    					"Pending":false,
    					"ProjectId":"FP-7A1018ADE9179EE1",
    					"Retries":0,
    					"StartTime":1540796248000,
    					"Status":"OK",
    					"Type":"END"
    				}
    			]
    		},
    		"ProjectId":"FP-7A1018ADE9179EE1",
    		"RequestId":"EDF99BA3-F7AF-49B2-ABA1-36430A31F482",
    		"StartTime":1540796236000,
    		"Status":"SUCCEEDED"
    	},
    	"requestId":"EDF99BA3-F7AF-49B2-ABA1-36430A31F482",
    	"successResponse":true
    }
  • Error response examples
    JSON format
    {
    	"code":"FLOW_API_FAILED",
    	"message":"flow instance does not exist [FI-7CAF9709CD328EB]",
    	"requestId":"9AEDC439-1F63-491D-B8C6-9737C372BF3A",
    	"successResponse":false
    }

Error codes.

View error codes.