You can call the DescribeFlowNodeInstance operation to query the details of node instances, including workflow node instances and job running node instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFlowNodeInstance

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to DescribeFlowNodeInstance.

Id String Yes FNI-FE4BD156E939****

The ID of the ECS instance that is added to the ACK cluster. You can call ListFlowNodeInstance View the ID of the node instance.

ProjectId String Yes FP-7A1018ADE917****

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

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

Response parameters

Parameter Type Example Description
Adhoc Boolean true

Indicates whether the job is a temporary query job.
ClusterId String C-F32FB31D8295****

The ID of the cluster.
ClusterName String myCluster

The name of the cluster.
Duration Long 200

The running duration, in milliseconds.
EndTime Long 1540796248000

The time when the execution of the job instance ended.
EnvConf String {"key":"value"}

The environment variables configured for the job.
ExternalChildIds String application_1541559535023_34028

Of the task application The details about an item.

ExternalId String application_1541559535023_34027

Of the initiator application ID.

ExternalInfo String empty

The external information. For example, the error diagnosis information of running jobs.

ExternalStatus String SUCCESS

The status of the Container corresponding to the instance:

  • SUBMITTED (SUBMITTED)
  • RUNNING
  • SUCCESS (execution successful)
  • FAIL: The execution failed.
  • KILL_FAIL (termination failure)
  • KILL_SUCCESS (termination successful)
ExternalSubId String container_1541559535023_34027_01_000001

Initiator container ID.

FailAct String STOP

The action to take upon an operation failure of the node instance. Valid values:

  • STOP (terminate the workflow)
  • CONTINUE (skip)
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 node instance is run. You can log on to the host to use the hostname Command to view 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.
MaxRetry String 0

The maximum number of retries of running the node instance if a failure occurs.
Mode String YARN

The mode of the model. Supported: YARN and LOCAL YARN. YARN: submits the job from a worker node Jobs run as processes directly on the host.

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 of the job. This parameter only applies to SPARK_STREAMING jobs.

NodeName String The name of the node

The name of the node.
ParamConf String {"date":"${yyyy-MM-dd}"}

The configuration parameters of the job.
Pending Boolean true

Indicates whether the execution of the node instance ended.
ProjectId String FP-7A1018ADE917****

The ID of the project.
RequestId String 1549175a-6d14-4c8a-89f9-5e28300f6d7e

The ID of the request.
Retries Integer 0

The number of retries of running the node instance.
RetryInterval String 15

The retry interval, in units. s .

RetryPolicy String None

The retry policy. A reserved parameter.
RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

The scheduling parameters configured for the job.

  • priority: the priority of the job.
  • userName: The linux user used to submit jobs.
  • memory: the memory allocated to the job. Unit: MB.
  • cores: the number of vCPUs allocated to the job.
StartTime Long 1540796237000

The time when the execution of the job instance started.
Status String OK

The execution status of the instance. Valid values:

  • PREP (waiting to start)
  • SUBMITTING (SUBMITTING)
  • RUNNING
  • DONE (completed)
  • OK (successful execution)
  • FAILED (execution FAILED)
  • KILLED (terminated)
  • KILL_FAILED (termination failed)
  • START_RETRY
Type String JOB

The type of the node. Valid values:

  • JOB (JOB)
  • CLUSTER
  • START (START)
  • END

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeFlowNodeInstance
&Id=FNI-FE4BD156E939****
&ProjectId=FP-7A1018ADE917****
&RegionId=cn-hangzhou
&<<common request parameters>

Sample success responses

XML format 

<data>
    <FailAct>STOP</FailAct>
    <EndTime>1542884476000</EndTime>
    <NodeName>812589f5</NodeName>
    <GmtModified>1542884475000</GmtModified>
    <JobName>success</JobName>
    <ExternalStatus>SUCCESS</ExternalStatus>
    <FlowId>F-60C9B1257A80****</FlowId>
    <ParamConf>
        <cyctime>2018-11-22 19:00:00</cyctime>
    </ParamConf>
    <ExternalInfo/>
    <Retries>0</Retries>
    <ClusterName>myCluster</ClusterName>
    <JobId>FJ-EE3AF471B2E6****</JobId>
    <HostName>emr-header-1.cluster-500159692</HostName>
    <JobParams>sleep 10;
exit 0;</JobParams>
    <Status>OK</Status>
    <RequestId>F5540D8F-06E8-4E3C-B47A-D75CED72A795</RequestId>
    <ClusterId>C-F32FB31D8295****</ClusterId>
    <ExternalId>application_1541559535023_34027</ExternalId>
    <StartTime>1542884402000</StartTime>
    <ProjectId>FP-3535FE0BE522****</ProjectId>
    <FlowInstanceId>FI-C112BB938D2C****</FlowInstanceId>
    <Duration>74000</Duration>
    <ExternalSubId>container_1541559535023_34027_01_000001</ExternalSubId>
    <MaxRetry>0</MaxRetry>
    <Type>JOB</Type>
    <GmtCreate>1542884401000</GmtCreate>
    <JobType>SHELL</JobType>
    <RetryInterval>15</RetryInterval>
    <Id>FNI-E548777B9DCD****</Id>
    <Pending>false</Pending>
</data>
<requestId>F5540D8F-06E8-4E3C-B47A-D75CED72A795</requestId>

JSON Syntax 

{
    "data": {
        "FailAct": "STOP",
        "EndTime": 1542884476000,
        "NodeName": "812589f5",
        "GmtModified": 1542884475000,
        "JobName": "success",
        "ExternalStatus": "SUCCESS",
        "FlowId": "F-60C9B1257A80****",
        "ParamConf": {
            "cyctime": "2018-11-22 19:00:00"
        },
        "ExternalInfo": "",
        "Retries": 0,
        "ClusterName": "myCluster",
        "JobId": "FJ-EE3AF471B2E6****",
        "HostName": "emr-header-1.cluster-500159692",
        "JobParams": "sleep 10;\nexit 0;",
        "Status": "OK",
        "RequestId": "F5540D8F-06E8-4E3C-B47A-D75CED72A795",
        "ClusterId": "C-F32FB31D8295****",
        "ExternalId": "application_1541559535023_34027",
        "StartTime": 1542884402000,
        "ProjectId": "FP-3535FE0BE522****",
        "FlowInstanceId": "FI-C112BB938D2C****",
        "Duration": 74000,
        "ExternalSubId": "container_1541559535023_34027_01_000001",
        "MaxRetry": "0",
        "Type": "JOB",
        "GmtCreate": 1542884401000,
        "JobType": "SHELL",
        "RetryInterval": "15",
        "Id": "FNI-E548777B9DCD****",
        "Pending": false
    },
    "requestId": "F5540D8F-06E8-4E3C-B47A-D75CED72A795"
}