Queries the information about the nodes in an execution record of a task flow.

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 GetTaskInstanceRelation

The operation that you want to perform. Set the value to GetTaskInstanceRelation.

DagId Long Yes 7***

The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to obtain the ID of the task flow.

DagInstanceId Long Yes 47****

The ID of the execution record of the task flow. You can call the ListTaskFlowInstance operation to obtain the execution record ID.

Tid Long No 3***

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

RegionId String No cn-hangzhou

The region in which Data Management (DMS) is activated. For more information, see RegionID parameter.

Response parameters

Parameter Type Example Description
RequestId String 028BF827-3801-5869-8548-F4A039256304

The ID of the request.

ErrorCode String UnknownError

The error code returned if the request fails.

ErrorMessage String UnknownError

The error message returned if the request fails.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
NodeList Array of Node

The information about the nodes in the execution record of the task flow.

Node
Id Long 14059

The ID of the execution record of the task flow.

NodeId Long 14059

The ID of the node.

NodeName String Spark SQL-1

The name of the node.

NodeType Integer 36

The type of the node. For more information about the valid values for this parameter, see NodeType parameter.

BusinessTime String 2021-11-09 14:37:26

The business time of the node.

Status Integer 4

The status of the node. Valid values:

  • 0: The node is waiting to be scheduled.
  • 1: The node is running.
  • 2: The node is suspended.
  • 3: The node failed to run.
  • 4: The node is run.
  • 5: The node is complete.
Message String test

The description of the task.

ExecuteTime Long 170655

The amount of time consumed for running the node. Unit: milliseconds.

EndTime String 2021-11-11 14:38:57

The time when the execution of the task flow was complete. The time is displayed in the yyyy-MM-DD HH:mm:ss format.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=GetTaskInstanceRelation
&DagId=7***
&DagInstanceId=47****
&Tid=3***
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTaskInstanceRelationResponse>
    <RequestId>028BF827-3801-5869-8548-F4A039256304</RequestId>
    <Success>true</Success>
    <NodeList>
        <Id>14059</Id>
        <NodeId>14059</NodeId>
        <NodeName>Spark SQL-1</NodeName>
        <NodeType>36</NodeType>
        <BusinessTime>2021-11-09 14:37:26</BusinessTime>
        <Status>4</Status>
        <Message>test</Message>
        <ExecuteTime>170655</ExecuteTime>
        <EndTime>2021-11-11 14:38:57</EndTime>
    </NodeList>
</GetTaskInstanceRelationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "028BF827-3801-5869-8548-F4A039256304",
  "Success" : true,
  "NodeList" : [ {
    "Id" : 14059,
    "NodeId" : 14059,
    "NodeName" : "Spark SQL-1",
    "NodeType" : 36,
    "BusinessTime" : "2021-11-09 14:37:26",
    "Status" : 4,
    "Message" : "test",
    "ExecuteTime" : 170655,
    "EndTime" : "2021-11-11 14:38:57"
  } ]
}

Error codes

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