Call ListFlowNodeInstance to query workflow node instances.

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 the Action parameter. Set this parameter to ListFlowNodeInstance.

RegionId String Yes cn-hangzhou

The region ID of the security group to be queried. You can call the DescribeRegions operation to query the most recent region list.

ProjectId String Not required. FP-257A173659F5****

The ID of the project. You can call ListFlowProject view the project ID.

StartTime Long Not required. 1540796248000

The beginning of the time range where workflow node instances are queried.

StatusList.N RepeatList Not required. FAILED

The status of the job instance. Valid values:

  • SUBMITTED
  • RUNNING
  • SUCCESS
  • FAILED
  • KILL_FAILED
  • KILL_SUCCESS
OrderBy String Not required. start_time

The sort field.

OrderType String Not required. desc

Sort type:

  • ASC
  • DESC
PageNumber Integer Not required. 1

The page number of the returned page.

PageSize Integer Not required. 20

The number of entries returned on each page.

ResourceGroupId String Not required. rg-bp67acfmxazb4p****

The ID of the resource group to which to add the resource. You can call ListResourceGroups 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 PolarDB cluster.

Duration Long 200

The running duration, in milliseconds.

EndTime Long 1540796248000

The time when the workflow node instance stopped.

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:

  • SUBMITTED
  • RUNNING
  • SUCCESS
  • 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 (terminates the workflow)
  • CONTINUE
FlowId String F-35683D0E4573****

The ID of the workflow.

FlowInstanceId String FI-7CAF9709CD32****

The ID of the workflow instance.

GmtCreate Long 1540796236000

The creation time of the project.

GmtModified Long 1540796247000

The time when the workflow node instance was 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 format of the hostname is emr-header-1.cluster-12345. You can log on to the host and run the hostname command to check the hostname.

Id String FNI-9D14A7CCF268****

The ID of the workflow node instance.

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: MR, Spark, Hive_SQL, Hive, Pig, Sqoop, Spark_SQL, Spark_Streaming, and Shell.

MaxRetry String 0

The maximum number of times the job can be retried.

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 of running the node instance.

RetryInterval String 200

The retry interval, in milliseconds.

StartTime Long 1540796237000

The time when the job started.

Status String OK

The execution status of the instance. Valid values:

  • PREP (pending start)
  • SUBMITTING
  • RUNNING
  • DONE
  • OK (executed successfully)
  • FAILED
  • KILLED
  • KILL_FAILED
  • START_RETRY
Type String JOB

The type of the node.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The page number of the returned page.

RequestId String 83B256D4-4E95-454B-AD08-799DF31D5556

The ID of the instance.

Total Integer 12

The total number of returned entries.

Examples

Sample requests

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

Sample success 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"
}

Error codes

For a list of error codes, visit the API Error Center.