All Products
Search
Document Center

DataWorks:GetNodeChildren

Last Updated:Nov 21, 2024

Queries a list of instances.

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
dataworks:*get
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectEnvstringYes

The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.

PROD
NodeIdlongYes

The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.

123456878

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID. You can use the ID to troubleshoot issues.

adsfasdf-adf-asdf-asdf-asdfadfasdd
ErrorMessagestring

The error message.

err
ErrorCodestring

The error code.

1060010000000
Successboolean

Indicates whether the request was successful.

true
Dataobject

The information about the descendant nodes.

Nodesarray<object>

The list of descendant nodes.

Nodesobject
SchedulerTypestring

The scheduling type of the node. Valid values:

  • NORMAL: The node is an auto triggered node.
  • MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.
  • PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.
  • SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.
NORMAL
BaselineIdlong

The baseline ID.

12345656
Repeatabilityboolean

Indicates whether the node can be rerun if the node fails to run. Valid values:

  • true
  • false
true
NodeNamestring

The name of the node.

test_Node
ProjectIdlong

The ID of the workspace to which the node belongs.

12315412412
ProgramTypestring

The type of the node.

ODPS_SQL
Priorityinteger

The priority. Valid values: 1 to 8. A large value indicates a high priority.

3
OwnerIdstring

The ID of the Alibaba Cloud account used by the node owner.

123124561341251321
CronExpressstring

The CRON expression. CRON expressions are used to run auto triggered nodes.

00 00 * * * *
NodeIdlong

The node ID.

1244564565

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "adsfasdf-adf-asdf-asdf-asdfadfasdd",
  "ErrorMessage": "err",
  "ErrorCode": "1060010000000",
  "Success": true,
  "Data": {
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "BaselineId": 12345656,
        "Repeatability": true,
        "NodeName": "test_Node",
        "ProjectId": 12315412412,
        "ProgramType": "ODPS_SQL",
        "Priority": 3,
        "OwnerId": "123124561341251321",
        "CronExpress": "00 00 * * * * ",
        "NodeId": 1244564565,
        "StepType": ""
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-30The response structure of the API has changedView Change Details