All Products
Search
Document Center

Data Management:GetTaskInstanceRelation

Last Updated:Nov 28, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetTaskInstanceRelationget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DagIdlongYes

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

7***
DagInstanceIdlongYes

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

47****
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

028BF827-3801-5869-8548-F4A039256304
ErrorCodestring

The error code returned if the request fails.

UnknownError
ErrorMessagestring

The error message returned if the request fails.

UnknownError
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
NodeListarray<object>

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

Nodeobject
Idlong

The ID of the execution record of the task flow.

14059
NodeIdlong

The ID of the node.

14059
NodeNamestring

The name of the node.

Spark SQL-1
NodeTypeinteger

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

36
BusinessTimestring

The business time of the node.

2021-11-09 14:37:26
Statusinteger

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.
4
Messagestring

The description of the task.

test
ExecuteTimelong

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

170655
EndTimestring

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

2021-11-11 14:38:57

Examples

Sample success responses

JSONformat

{
  "RequestId": "028BF827-3801-5869-8548-F4A039256304",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "NodeList": {
    "Node": [
      {
        "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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history