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

Request parameters

Name Type Required Example Description
Id String Yes FNI-FE4BD156E939CF1F The ID of the workflow node instance or the job instance.
ProjectId String Yes FP-7A1018ADE9179EE1 The ID of the project.
RegionId String Yes cn-hangzhou The ID of the region.

Response parameters

Name Type Example Description
RequestId String 1549175a-6d14-4c8a-89f9-5e28300f6d7e The ID of the request.
Id String FNI-9D14A7CCF2687B84 The ID of the workflow node instance or the job instance.
GmtCreate Long 1540796236000 The creation time.
GmtModified Long 1540796247000 The modification time.
Type String JOB Thet type of the workflow node. Valid values: JOB, CLUSTER, START, and END.
Status String OK The status of the workflow node instance. Valid values: PREP, SUBMITTING, RUNNING, DONE, OK, FAILED, KILLED, KILL_FAILED, and START_RETRY.
JobId String FJ-A23BD131A862F184 The ID of the job.
JobName String myJob The name of the job.
JobType String HIVE_SQL The type of the job.
JobParams String ls -l The content of the 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 The name of the workflow node. The name of the workflow node.
FlowId String F-35683D0E45734E34 The ID of the workflow.
FlowInstanceId String FI-7CAF9709CD328EBE The ID of the workflow instance.
ClusterId String C-A6C9F4F1E9EC88D9 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 instance is running.
StartTime Long 1540796237000 The time when the instance starts running.
EndTime Long 1540796248000 The time when the instance ends running.
Duration Long 200 The run time duration of the instance.
Retries Integer 0 The number of the retries.
ExternalId String application_1541559535023_34027 The ID of the launcher application.
ExternalSubId String container_1541559535023_34027_01_000001 The container ID of the launcher.
ExternalChildIds String application_1541559535023_34028 The application list of the jobs.
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.
ParamConf String {"date":"${yyyy-MM-dd}"} The configurations of the parameters.
EnvConf String {"key":"value"} The environment variables.
RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1} The run configurations. priority: The priority to run the instance. userName: The Linux user that submits the instance. memory: The size of the allocated memory for running the instance. Unit: megabytes. cores: The number of allocated vCPUs for running the instance.
Adhoc Boolean true Indicates whether the instance is an ad-hoc query.
MonitorConf String {"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]} The monitoring configurations. Only jobs of the SPARK_STREAMING type are supported.
Mode String YARN The mode of the model. Valid values: YARN and LOCAL. YARN: The job is submitted to and runs on YARN as a launcher. LOCAL: The job runs on the local machine as a process.
ClusterName String myCluster The name of the cluster.

Examples

  • Sample requests
    
    /? Action=DescribeFlowNodeInstance
    &Id=node_instance_id
    &ProjectId=FP-7A1018ADE9179EE1
    &RegionId=cn-hangzhou
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"code":"200",
    	"data":{
    		"ClusterId":"C-F32FB31D82954C64",
    		"ClusterName":"mingbo-v199v1",
    		"Duration":74000,
    		"EndTime":1542884476000,
    		"ExternalId":"application_1541559535023_34027",
    		"ExternalInfo":"",
    		"ExternalStatus":"SUCCESS",
    		"ExternalSubId":"container_1541559535023_34027_01_000001",
    		"FailAct":"STOP",
    		"FlowId":"F-60C9B1257A804624",
    		"FlowInstanceId":"FI-C112BB938D2C5FBF",
    		"GmtCreate":1542884401000,
    		"GmtModified":1542884475000,
    		"HostName":"emr-header-1.cluster-500159692",
    		"Id":"FNI-E548777B9DCD2237",
    		"JobId":"FJ-EE3AF471B2E69785",
    		"JobName":"success",
    		"JobParams":"sleep 10;\nexit 0;",
    		"JobType":"SHELL",
    		"MaxRetry":"0",
    		"NodeName":"812589f5",
    		"ParamConf":{
    			"cyctime":"2018-11-22 19:00:00"
    		},
    		"Pending":false,
    		"ProjectId":"FP-3535FE0BE5224A47",
    		"RequestId":"F5540D8F-06E8-4E3C-B47A-D75CED72A795",
    		"Retries":0,
    		"RetryInterval":"15",
    		"StartTime":1542884402000,
    		"Status":"OK",
    		"Type":"JOB"
    	},
    	"requestId":"F5540D8F-06E8-4E3C-B47A-D75CED72A795",
    	"successResponse":true
    }
  • Error response examples
    JSON format
    {
    	"code":"FLOW_API_FAILED",
    	"message":"Project does not exist [FP-3535FE0BE5224A4]",
    	"requestId":"83B256D4-4E95-454B-AD08-799DF31D5556",
    	"successResponse":false
    }

Error codes

View error codes.