You can call DescribeFlowInstance operation to query the information of a workflow instance.

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 DescribeFlowInstance

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 DescribeFlowInstance.

Id String Yes FI-7CAF9709CD32****

The ID of the workflow. You can call ListFlowInstance View the workflow ID.

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
ClusterId String C-F32FB31D8295****

The ID of the cluster.

Duration Long 12000

Running duration, in units ms .

EndTime Long 1540796248000

The time when the execution of the workflow instance ended.

FlowId String F-35683D0E4573****

The ID of the workflow.

FlowName String flow-hive

The name of the workflow.

GmtCreate Long 1540796248000

The time when the accelerated domain name was created.

GmtModified Long 1540796248000

The modification time of the workflow.

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 information of the workflow graph.

Id String FI-7CAF9709CD32****

The ID of the workflow instance.

NodeInstance Array of NodeInstance

The node instances of the workflow instance.

NodeInstance
ClusterId String C-F32FB31D8295****

The ID of the cluster.

Duration Long 11000

The execution time of the node instance.

EndTime Long 1540796248000

The time when the node instance execution ended.

ExternalId String application_1540362938289_1858

The external ID. For example, the initiator ApplicationId .

ExternalInfo String empty

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

ExternalStatus String SUCCESS

The external status of the job instance. Valid values:

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

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

  • STOP (terminate the workflow)
  • CONTINUE (skip)
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-9D14A7CCF26****

The ID of the workflow node instance.

JobId String FJ-C6C794219DE6****

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.

MaxRetry String 0

The maximum number of times the job can be retried.

NodeName String 2f089966

The name of the node.

Pending Boolean true

Indicates whether the execution of the node instance ended.

ProjectId String FP-7A1018ADE917****

The ID of the project.

Retries Integer 0

The number of retries of running the node instance.

RetryInterval String 15

The retry interval. Unit: s.

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
  • CLUSTER
  • START
  • END
ProjectId String FP-7A1018ADE917****

The ID of the project.

RequestId String EDF99BA3-F7AF-49B2-ABA1-36430A31F482

The ID of the request.

StartTime Long 1540796236000

The time when the execution of the workflow instance started.

Status String SUCCEEDED

The execution status of the instance. Valid values:

  • PREP (preparing)
  • RUNNING
  • SUCCEEDED
  • FAILED (FAILED)
  • KILLED (terminated)
  • SUSPENDED

Examples

Sample requests

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

Sample success responses

XML format

<Status>SUCCEEDED</Status>
<RequestId>EDF99BA3-F7AF-49B2-ABA1-36430A31F482</RequestId>
<EndTime>1540796248000</EndTime>
<ClusterId>C-F32FB31D8295****</ClusterId>
<GmtModified>1540796247000</GmtModified>
<StartTime>1540796236000</StartTime>
<ProjectId>FP-7A1018ADE917****</ProjectId>
<Duration>12000</Duration>
<FlowId>F-35683D0E4573****</FlowId>
<GmtCreate>1540796235000</GmtCreate>
<Graph>
    <nodes>
        <shape>startControlNode</shape>
        <size>80*34</size>
        <spmAnchorId>0.0.0.i0.766645eb2c****</spmAnchorId>
        <x>500</x>
        <y>250</y>
        <index>0</index>
        <id>48d4****</id>
        <attribute>
            <type>START</type>
        </attribute>
        <type>node</type>
    </nodes>
    <nodes>
        <shape>hiveSQLJobNode</shape>
        <size>170*34</size>
        <spmAnchorId>5176.8250060.0.i11.499128d0KW****</spmAnchorId>
        <x>515</x>
        <y>334.5</y>
        <index>1</index>
        <id>2f089966</id>
        <label>hive-test</label>
        <attribute>
            <jobId>FJ-C6C794219DE6****</jobId>
            <type>JOB</type>
            <jobType>HIVE_SQL</jobType>
        </attribute>
        <type>node</type>
        <config>
            <hostName/>
            <clusterId/>
        </config>
    </nodes>
    <nodes>
        <shape>endControlNode</shape>
        <size>80*34</size>
        <spmAnchorId>5176.8250060.0.i15.499128d0KW****</spmAnchorId>
        <x>532</x>
        <y>453.5</y>
        <index>2</index>
        <id>ac09****</id>
        <attribute>
            <type>END</type>
        </attribute>
        <type>node</type>
    </nodes>
    <edges>
        <sourceAnchor>0</sourceAnchor>
        <targetAnchor>0</targetAnchor>
        <index>3</index>
        <source>48d474ea</source>
        <id>77e6****</id>
        <target>2f089966</target>
    </edges>
    <edges>
        <sourceAnchor>1</sourceAnchor>
        <targetAnchor>0</targetAnchor>
        <index>4</index>
        <source>2f089966</source>
        <id>95ba****</id>
        <target>ac092a54</target>
    </edges>
</Graph>
<ScheduleTime>1596596400000</ScheduleTime>
<FlowName>flow-hive</FlowName>
<Id>FI-7CAF9709CD32****</Id>
<DependencyFlowList>
</DependencyFlowList>
<NodeInstance>
    <NodeInstance>
        <FailAct>STOP</FailAct>
        <Status>OK</Status>
        <EndTime>1540796236000</EndTime>
        <ClusterId>C-F32FB31D8295****</ClusterId>
        <NodeName>:start:</NodeName>
        <GmtModified>1540796236000</GmtModified>
        <StartTime>1540796236000</StartTime>
        <ProjectId>FP-7A1018ADE917****</ProjectId>
        <Duration>0</Duration>
        <MaxRetry>0</MaxRetry>
        <Type>START</Type>
        <GmtCreate>1540796236000</GmtCreate>
        <Retries>0</Retries>
        <Id>FNI-1286C1ED46C4****</Id>
        <HostName/>
        <Pending>false</Pending>
    </NodeInstance>
    <NodeInstance>
        <FailAct>STOP</FailAct>
        <Status>OK</Status>
        <EndTime>1540796248000</EndTime>
        <ClusterId>C-F32FB31D8295****</ClusterId>
        <NodeName>2f089966</NodeName>
        <ExternalId>application_1540362938289_1858</ExternalId>
        <JobName>hive-test</JobName>
        <GmtModified>1540796247000</GmtModified>
        <StartTime>1540796237000</StartTime>
        <ProjectId>FP-7A1018ADE917****</ProjectId>
        <Duration>11000</Duration>
        <MaxRetry>0</MaxRetry>
        <ExternalStatus>SUCCESS</ExternalStatus>
        <Type>JOB</Type>
        <GmtCreate>1540796236000</GmtCreate>
        <JobType>HIVE_SQL</JobType>
        <ExternalInfo/>
        <Retries>0</Retries>
        <RetryInterval>15</RetryInterval>
        <Id>FNI-9D14A7CCF268****</Id>
        <HostName>emr-header-1.cluster-500159692</HostName>
        <JobId>FJ-C6C794219DE6****</JobId>
        <Pending>false</Pending>
    </NodeInstance>
    <NodeInstance>
        <FailAct>STOP</FailAct>
        <Status>OK</Status>
        <EndTime>1540796248000</EndTime>
        <ClusterId>C-F32FB31D8295****</ClusterId>
        <NodeName>ac092a54</NodeName>
        <GmtModified>1540796247000</GmtModified>
        <StartTime>1540796248000</StartTime>
        <ProjectId>FP-7A1018ADE917****</ProjectId>
        <Duration>0</Duration>
        <MaxRetry>0</MaxRetry>
        <Type>END</Type>
        <GmtCreate>1540796247000</GmtCreate>
        <Retries>0</Retries>
        <Id>FNI-14C14E312AF9****</Id>
        <HostName/>
        <Pending>false</Pending>
    </NodeInstance>
</NodeInstance>

JSON Syntax

{
        "Status": "SUCCEEDED",
        "RequestId": "EDF99BA3-F7AF-49B2-ABA1-36430A31F482",
        "EndTime": 1540796248000,
        "ClusterId": "C-F32FB31D8295****",
        "GmtModified": 1540796247000,
        "StartTime": 1540796236000,
        "ProjectId": "FP-7A1018ADE917****",
        "Duration": 12000,
        "FlowId": "F-35683D0E4573****",
        "GmtCreate": 1540796235000,
        "Graph": {
            "nodes": [
                {
                    "shape": "startControlNode",
                    "size": "80*34",
                    "spmAnchorId": "0.0.0.i0.766645eb2c****",
                    "x": 500,
                    "y": 250,
                    "index": 0,
                    "id": "48d4****",
                    "attribute": {
                        "type": "START"
                    },
                    "type": "node"
                },
                {
                    "shape": "hiveSQLJobNode",
                    "size": "170*34",
                    "spmAnchorId": "5176.8250060.0.i11.499128d0KW****",
                    "x": 515,
                    "y": 334.5,
                    "index": 1,
                    "id": "2f089966",
                    "label": "hive-test",
                    "attribute": {
                        "jobId": "FJ-C6C794219DE6****",
                        "type": "JOB",
                        "jobType": "HIVE_SQL"
                    },
                    "type": "node",
                    "config": {
                        "hostName": "",
                        "clusterId": ""
                    }
                },
                {
                    "shape": "endControlNode",
                    "size": "80*34",
                    "spmAnchorId": "5176.8250060.0.i15.499128d0KW****",
                    "x": 532,
                    "y": 453.5,
                    "index": 2,
                    "id": "ac09****",
                    "attribute": {
                        "type": "END"
                    },
                    "type": "node"
                }
            ],
            "edges": [
                {
                    "sourceAnchor": 0,
                    "targetAnchor": 0,
                    "index": 3,
                    "source": "48d474ea",
                    "id": "77e6****",
                    "target": "2f089966"
                },
                {
                    "sourceAnchor": 1,
                    "targetAnchor": 0,
                    "index": 4,
                    "source": "2f089966",
                    "id": "95ba****",
                    "target": "ac092a54"
                }
            ]
        },
        "ScheduleTime": 1596596400000,
        "FlowName": "flow-hive",
        "Id": "FI-7CAF9709CD32****",
        "DependencyFlowList": {
        "ParentFlow": []
        },
        "NodeInstance": {
            "NodeInstance": [
                {
                    "FailAct": "STOP",
                    "Status": "OK",
                    "EndTime": 1540796236000,
                    "ClusterId": "C-F32FB31D8295****",
                    "NodeName": ":start:",
                    "GmtModified": 1540796236000,
                    "StartTime": 1540796236000,
                    "ProjectId": "FP-7A1018ADE917****",
                    "Duration": 0,
                    "MaxRetry": "0",
                    "Type": "START",
                    "GmtCreate": 1540796236000,
                    "Retries": 0,
                    "Id": "FNI-1286C1ED46C4****",
                    "HostName": "",
                    "Pending": false
                },
                {
                    "FailAct": "STOP",
                    "Status": "OK",
                    "EndTime": 1540796248000,
                    "ClusterId": "C-F32FB31D8295****",
                    "NodeName": "2f089966",
                    "ExternalId": "application_1540362938289_1858",
                    "JobName": "hive-test",
                    "GmtModified": 1540796247000,
                    "StartTime": 1540796237000,
                    "ProjectId": "FP-7A1018ADE917****",
                    "Duration": 11000,
                    "MaxRetry": "0",
                    "ExternalStatus": "SUCCESS",
                    "Type": "JOB",
                    "GmtCreate": 1540796236000,
                    "JobType": "HIVE_SQL",
                    "ExternalInfo": "",
                    "Retries": 0,
                    "RetryInterval": "15",
                    "Id": "FNI-9D14A7CCF268****",
                    "HostName": "emr-header-1.cluster-500159692",
                    "JobId": "FJ-C6C794219DE6****",
                    "Pending": false
                },
                {
                    "FailAct": "STOP",
                    "Status": "OK",
                    "EndTime": 1540796248000,
                    "ClusterId": "C-F32FB31D8295****",
                    "NodeName": "ac092a54",
                    "GmtModified": 1540796247000,
                    "StartTime": 1540796248000,
                    "ProjectId": "FP-7A1018ADE917****",
                    "Duration": 0,
                    "MaxRetry": "0",
                    "Type": "END",
                    "GmtCreate": 1540796247000,
                    "Retries": 0,
                    "Id": "FNI-14C14E312AF9****",
                    "HostName": "",
                    "Pending": false
                }
            ]
        } 
}

Error code

The port number of a client that accesses a Error CenterFor more information, see error codes.