Query the list of workflow node instances - E-MapReduce - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListFlowNodeInstance	The operation that you want to perform. If you use a custom HTTP URL or HTTPS URL to make an API request, you must specify this parameter. Set this parameter to ListFlowNodeInstance.
RegionId	String	Yes	cn-hangzhou	The region ID of the Cloud Assistant command. You can call the DescribeRegions operation to query the most recent region list.
ProjectId	String	No	FP-257A173659F5****	The ID of the project. You can call the ListFlowProject to view the ID of the project.
StartTime	Long	No	1540796248000	The start time.
StatusList.N	RepeatList	No	FAILED	The status of the job instance. Valid values: SUBMITTED (Submitted) RUNNING: The node is running. SUCCESS: The node is run as expected. FAILED KILL_FAILED KILL_SUCCESS
OrderBy	String	No	start_time	The field that is used to sort data.
OrderType	String	No	desc	Sort type: ASC DESC
PageNumber	Integer	No	1	The number of the page to return.
PageSize	Integer	No	20	The number of entries to return on each page.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	The ID of the resource group. You can call the ListResourceGroups to view the resource group ID.

Response parameters


Parameter	Type	Example	Description
FlowNodeInstances	Array of FlowNodeInstance		The list of workflow node instances.
FlowNodeInstance
ClusterId	String	C-A6C9F4F1E9E****	The ID of the cluster.
Duration	Long	200	The execution time of the node instance.
EndTime	Long	1540796248000	The time when the execution of the workflow instance ended.
ExternalChildIds	String	application_1541559535023_34028	The application list of the tasks of the job.
ExternalId	String	application_1541559535023_3****	The application ID of the launcher.
ExternalInfo	String	empty	The external information of the node instance, such as the error diagnosis information of the node instance.
ExternalStatus	String	SUCCESS	The status of the container corresponding to the instance. Valid values: SUBMITTED (Submitted) RUNNING: The node is running. SUCCESS: The node is run as expected. FAILED KILL_FAILED KILL_SUCCESS
ExternalSubId	String	container_1541559535023_34027_01_00****	The container ID of the launcher.
FailAct	String	STOP	The action to take upon an operation failure of the node instance. Valid values: STOP (Terminate Workflow) CONTINUE (skipped)
FlowId	String	F-35683D0E4573****	The ID of the workflow.
FlowInstanceId	String	FI-7CAF9709CD32****	The ID of the workflow instance.
GmtCreate	Long	1540796236000	The time when the job was created.
GmtModified	Long	1540796247000	The time when the job was last modified.
HostName	String	emr-header-1.cluster-12345	The name of the host where the workflow node instance is running. The host can be a master node or gateway node. The hostname format is emr-header-1.cluster-12345. You can log on to the machine and run the hostname command to view the corresponding value.
Id	String	FNI-9D14A7CCF268****	The ID of the instance on which the node is deployed.
JobId	String	FJ-A23BD131A862****	The ID of the job.
JobName	String	myJob	The name of the job.
JobParams	String	ls -l	The content of the job.
JobType	String	HIVE_SQL	The type of the job. Valid values: SPARK_SQL, SPARK_STREAMING, MR, SQOOP, FLINK, STREAMING_SQL, IMPALA_SQL, PRESTO_SQL, SPARK, HIVE_SQL, HIVE, SHELL, and SPARK_SHELL.
MaxRetry	String	0	The maximum number of retries for writing data to the table.
NodeName	String	node	The name of the node.
Pending	Boolean	false	Indicates whether the workflow node instance was completed.
ProjectId	String	FP-7A1018ADE917****	The ID of the project.
Retries	Integer	0	The number of retries allowed.
RetryInterval	String	200	The retry interval at which data is read.
StartTime	Long	1540796237000	The time when the node instance started to run.
Status	String	OK	The execution status of the instance. Valid values: PREP (waiting to start) SUBMITTING RUNNING: The node is running. DONE (Completed) OK FAILED KILLED (terminated) KILL_FAILED START_RETRY
Type	String	JOB	The node type.
PageNumber	Integer	1	The number of the returned page.
PageSize	Integer	20	The number of entries to return on each page.
RequestId	String	83B256D4-4E95-454B-AD08-799DF31D5556	The ID of the request.
Total	Integer	12	The count of the O&M events.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListFlowNodeInstance
&RegionId=cn-hangzhou
&<Common request parameters>

Sample responses

XML format

<RequestId>83B256D4-4E95-454B-AD08-799DF31D5556</RequestId>
<PageSize>20</PageSize>
<PageNumber>1</PageNumber>
<FlowNodeInstances>
    <FlowNodeInstance>
        <FailAct>STOP</FailAct>
        <EndTime>1540796248000</EndTime>
        <NodeName>node</NodeName>
        <GmtModified>1540796247000</GmtModified>
        <JobName>myJob</JobName>
        <FlowId>F-35683D0E4573****</FlowId>
        <ExternalStatus>SUCCESS</ExternalStatus>
        <ExternalInfo>empty</ExternalInfo>
        <Retries>0</Retries>
        <JobId>FJ-A23BD131A862****</JobId>
        <JobParams>ls -l</JobParams>
        <HostName>emr-header-1.cluster-12345</HostName>
        <Status>OK</Status>
        <ClusterId>C-A6C9F4F1E9E****</ClusterId>
        <ExternalId>application_1541559535023_3****</ExternalId>
        <ProjectId>FP-7A1018ADE917****</ProjectId>
        <StartTime>1540796237000</StartTime>
        <FlowInstanceId>FI-7CAF9709CD32****</FlowInstanceId>
        <Duration>200</Duration>
        <MaxRetry>0</MaxRetry>
        <ExternalSubId>container_1541559535023_34027_01_00****</ExternalSubId>
        <GmtCreate>1540796236000</GmtCreate>
        <Type>JOB</Type>
        <JobType>HIVE_SQL</JobType>
        <ExternalChildIds>application_1541559535023_34028</ExternalChildIds>
        <Id>FNI-9D14A7CCF268****</Id>
        <RetryInterval>200</RetryInterval>
        <Pending>false</Pending>
    </FlowNodeInstance>
</FlowNodeInstances>
<Total>12</Total>

JSON format

{
    "RequestId":"83B256D4-4E95-454B-AD08-799DF31D5556",
    "PageSize":"20",
    "PageNumber":"1",
    "FlowNodeInstances":{
        "FlowNodeInstance":[
            {
                "FailAct":"STOP",
                "EndTime":"1540796248000",
                "NodeName":"node",
                "GmtModified":"1540796247000",
                "JobName":"myJob",
                "FlowId":"F-35683D0E4573****",
                "ExternalStatus":"SUCCESS",
                "ExternalInfo":"empty",
                "Retries":"0",
                "JobId":"FJ-A23BD131A862****",
                "JobParams":"ls -l",
                "HostName":"emr-header-1.cluster-12345",
                "Status":"OK",
                "ClusterId":"C-A6C9F4F1E9E****",
                "ExternalId":"application_1541559535023_3****",
                "ProjectId":"FP-7A1018ADE917****",
                "StartTime":"1540796237000",
                "FlowInstanceId":"FI-7CAF9709CD32****",
                "Duration":"200","MaxRetry":"0",
                "ExternalSubId":"container_1541559535023_34027_01_00****",
                "GmtCreate":"1540796236000",
                "Type":"JOB",
                "JobType":"HIVE_SQL",
                "ExternalChildIds":"application_1541559535023_34028",
                "Id":"FNI-9D14A7CCF268****",
                "RetryInterval":"200",
                "Pending":"false"
                }
            ]
        },
        "Total":"12"
}