All Products
Search
Document Center

:GetNodeChildren

更新時間:May 16, 2024

Queries the descendant nodes of a node.

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

GetNodeChildren

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

ProjectEnv

String

Yes

PROD

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.

NodeId

Long

Yes

123456878

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

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

Integer

200

The HTTP status code.

RequestId

String

adsfasdf-adf-asdf-asdf-asdfadfasdd

The request ID.

ErrorMessage

String

err

The error message.

ErrorCode

String

1060010000000

The error code.

Success

Boolean

true

Indicates whether the request was successful.

Data

Object

The information about the descendant nodes.

Nodes

Array of Nodes

The descendant nodes.

SchedulerType

String

NORMAL

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.

BaselineId

Long

12345656

The baseline ID.

Repeatability

Boolean

true

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

  • true

  • false

NodeName

String

test_Node

The name of the node.

ProjectId

Long

12315412412

The ID of the workspace to which the node belongs.

ProgramType

String

ODPS_SQL

The type of the node.

Priority

Integer

3

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

OwnerId

String

123124561341251321

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

CronExpress

String

00 00 * * * *

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

NodeId

Long

1244564565

The node ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetNodeChildren
&ProjectEnv=PROD
&NodeId=123456878
&<Common request parameters>

Sample success responses

XML format

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

<GetNodeChildrenResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>adsfasdf-adf-asdf-asdf-asdfadfasdd</RequestId>
    <ErrorMessage>err</ErrorMessage>
    <ErrorCode>1060010000000</ErrorCode>
    <Success>true</Success>
    <Data>
        <Nodes>
            <SchedulerType>NORMAL</SchedulerType>
            <BaselineId>12345656</BaselineId>
            <Repeatability>true</Repeatability>
            <NodeName>test_Node</NodeName>
            <ProjectId>12315412412</ProjectId>
            <ProgramType>ODPS_SQL</ProgramType>
            <Priority>3</Priority>
            <OwnerId>123124561341251321</OwnerId>
            <CronExpress>00 00 * * * * </CronExpress>
            <NodeId>1244564565</NodeId>
        </Nodes>
    </Data>
</GetNodeChildrenResponse>

JSON format

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

{
  "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
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.