Queries 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 Yes ListNodes

The operation that you want to perform.

ProjectEnv String Yes PROD

The environment of the workspace. Valid values: PROD and DEV.

ProjectId Long Yes 1234

The ID of the workspace.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

Owner String No 193379****

The ID of the owner of the node.

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 to return. Minimum value: 1. Maximum value: 100.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

NodeName String No liux_test_n****

The name of the node.

Response parameters

Parameter Type Example Description
Data Struct

The list of nodes.

Nodes Array of Nodes

The information about the nodes.

BaselineId Long 123456

The ID of the baseline.

Connection String odps_first

The connection string.

CronExpress String 00 00 00 * * ?

The cron expression returned.

Description String test

The description of the node.

DqcDescription String [{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

The table and partition filter expression in Data Quality that are associated with the instance.

DqcType Integer 1

Indicates whether the instance is associated with Data Quality. 0: The instance is associated with Data Quality. 1: The instance is not associated with Data Quality.

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 of the node.

ParamValues String a=b

Other parameters.

Priority Integer 1

Priority for running the node. Valid values: 1, 3, 5, 7, and 8.

ProgramType String ODPS_SQL

The type of the node.

ProjectId Long 33671

The ID of the workspace.

RelatedFlowId Long 1231123

The ID of the associated workflow.

RepeatInterval Long 60

Indicates the interval at which the node is rerun after the node fails to run.

Repeatability Boolean true

Indicates whether the node can be rerun.

ResGroupName String Default resource group

The name of the resource group.

SchedulerType String NORMAL

The type of the node. Valid values:

  • NORMAL: indicates that the node is a normal auto triggered node.
  • MANUAL: indicates that the node is a manually triggered node.
  • PAUSE: indicates that the node is a paused node.
  • SKIP: indicates that 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.
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page. Default value: 10. Maximum value: 100.

TotalCount Integer 66

The total number of nodes returned.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

ErrorMessage String The connection does not exist.

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String E6F0DBDD-5AD****

The ID of the request. You can use the ID to locate logs and troubleshoot issues.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListNodes
&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>10</PageSize>
    <PageNumber>1</PageNumber>
    <Nodes>
        <BaselineId>123456</BaselineId>
        <ResGroupName>Default resource group</ResGroupName>
        <Description>test</Description>
        <NodeName>liux_test_n****</NodeName>
        <DqcType>1</DqcType>
        <Priority>1</Priority>
        <ParamValues>a=b</ParamValues>
        <Connection>odps_first</Connection>
        <ProjectId>33671</ProjectId>
        <RelatedFlowId>1231123</RelatedFlowId>
        <SchedulerType>NORMAL</SchedulerType>
        <CronExpress>00 00 00 * * ?</CronExpress>
        <Repeatability>true</Repeatability>
        <OwnerId>19337906836551</OwnerId>
        <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
        <NodeId>1234</NodeId>
        <ProgramType>ODPS_SQL</ProgramType>
        <RepeatInterval>60</RepeatInterval>
    </Nodes>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "E6F0DBDD-5AD****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 66,
        "PageSize": 10,
        "PageNumber": 1,
        "Nodes": {
            "BaselineId": 123456,
            "ResGroupName": "Default resource group",
            "Description": "test",
            "NodeName": "liux_test_n****",
            "DqcType": 1,
            "Priority": 1,
            "ParamValues": "a=b",
            "Connection": "odps_first",
            "ProjectId": 33671,
            "RelatedFlowId": 1231123,
            "SchedulerType": "NORMAL",
            "CronExpress": "00 00 00 * * ?",
            "Repeatability": true,
            "OwnerId": 19337906836551,
            "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
            "NodeId": 1234,
            "ProgramType": "ODPS_SQL",
            "RepeatInterval": 60
        }
    },
    "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
    "ErrorMessage": "The connection does not exist.",
    "Success": true
}

Error codes

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