Obtains a list of nodes.

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 Required ListNodes

The operation that you want to perform.

NodeName String Required liux_test_n****

The name of the node.

ProjectEnv String Required PROD

The running environment in DEV and PROD modes.

ProjectId Long Yes 1234

The ID of the DataWorks workspace.

RegionId String Required cn-shanghai

Region information, which is usually the region where the service is located. For example, China (Shanghai) is cn-shanghai, and China (Zhangjiakou) is cn-zhangjiakou. You do not need to specify the RegionId because it is automatically resolved based on the endpoint that is called.

Owner String No 193379****

The ID of the owner.

BizName String No test_bizName

The name of the workflow.

ProgramType String No ODPS_SQL

The type of the node.

PageNumber Integer No 1

The number of the page.

PageSize Integer No 10

The number of entries returned per page.

Response parameters

Parameter Type Example Description
Data Struct

The list of nodes.

Nodes Array

The information about the node.

CronExpress String 00 00 00 * * ?

The cron expression of the time-based schedule.

Description String test

The description of the node.

NodeId Long 1234

The ID of the node.

NodeName String liux_test_n****

The name of the node.

OwnerId String 19337906836551

The ID of the owner.

ParamValues String a=b

Additional parameters.

ProgramType String ODPS_SQL

The type of the node.

ProjectId Long 33671

The ID of the DataWorks workspace.

Repeatability Boolean true

Whether the execution can be repeated.

ResGroupName String Default resource group

The alias of a resource group.

SchedulerType String NORMAL

The type of scheduling. Valid values: NORMAL (scheduled to tasks normally and scheduled on a daily basis), MANUAL (MANUAL tasks that are not scheduled on a daily basis), PAUSE (scheduled to tasks but directly set to failed when scheduling is started), and SKIP (dry-run tasks that are scheduled on a daily basis). However, the value is directly set to success when the scheduling is started.

PageNumber Integer 1

The number of the page.

PageSize Integer 5

The number of entries returned per page.

TotalCount Integer 66

The total number of nodes.

ErrorCode String 0

The error code.

ErrorMessage String test

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String E6F0DBDD-5AD****

The ID of the request. It is used to locate logs and troubleshoot problems.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListNodes
&NodeName=liux_test_n****
&ProjectEnv=PROD
&ProjectId=1234
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>E6F0DBDD-5AD****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>66</TotalCount>
    <PageSize>5</PageSize>
    <PageNumber>1</PageNumber>
    <Nodes>
        <Repeatability>true</Repeatability>
        <Description>test</Description>
        <ResGroupName> default resource group </ResGroupName>
        <OwnerId>19337906836551</OwnerId>
        <NodeName>liux_test_node_03</NodeName>
        <ParamValues>a=b</ParamValues>
        <NodeId>33114</NodeId>
        <ProjectId>33671</ProjectId>
        <SchedulerType>NORMAL</SchedulerType>
        <ProgramType>ODPS_SQL</ProgramType>
        <CronExpress>00 00 00 * * ? </CronExpress>
    </Nodes>
</Data>
<ErrorCode>0</ErrorCode>
<ErrorMessage>test</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "E6F0DBDD-5AD****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 66,
        "PageSize": 5,
        "PageNumber": 1,
        "Nodes": {
            "Repeatability": true,
            "Description": "test",
            "ResGroupName": "default resource group",
            "OwnerId": 19337906836551,
            "NodeName": "liux_test_node_03",
            "ParamValues": "a=b",
            "NodeId": 33114,
            "ProjectId": 33671,
            "SchedulerType": "NORMAL",
            "ProgramType": "ODPS_SQL",
            "CronExpress": "00 00 00 * * ?"
        }
    },
    "ErrorCode": 0,
    "ErrorMessage": "test",
    "Success": true
}

Errors

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