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. Set the value to ListNodes.

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.

ProjectId Long Yes 1234

The ID of the workspace.

ProjectEnv String Yes PROD

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

NodeName String No liux_test_n****

The name of the node.

Response parameters

Parameter Type Example Description
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.

ErrorMessage String The connection does not exist.

The error message returned.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code returned.

Success Boolean true

Indicates whether the request is successful.

Data Object

The list of nodes.

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.

Nodes Array of Nodes

The information about the nodes.

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 on schedule but the system configures the status of the nodes to successful when it starts to run them.
RepeatInterval Long 60

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

Repeatability Boolean true

Indicates whether the node can be rerun.

ProjectId Long 33671

The ID of the workspace.

ProgramType String ODPS_SQL

The type of the node.

Priority Integer 1

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

OwnerId String 19337906836551

The ID of the owner of the node.

Connection String odps_first

The connection string.

ParamValues String a=b

Other parameters.

RelatedFlowId Long 1231123

The ID of the associated workflow.

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.

BaselineId Long 123456

The ID of the baseline.

Description String test

The description of the node.

NodeName String liux_test_n****

The name of the node.

ResGroupName String Default resource group

The name of the resource group.

BusinessId Long 123

The ID of the workflow.

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.

CronExpress String 00 00 00 * * ?

The CRON expression returned.

NodeId Long 1234

The ID of the node.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListNodes
&Owner=193379****
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&ProjectId=1234
&ProjectEnv=PROD
&NodeName=liux_test_n****
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

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