Queries nodes based on the output of the 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 ListNodesByOutput

The operation that you want to perform.

Outputs String Yes aaaaa.1231412_out,bbbb.12313123_out

The output name of the node. You can specify multiple output names. In this case, separate them with commas (,).

ProjectEnv String Yes PROD

The environment type. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.

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 used to call the operation.

Response parameters

Parameter Type Example Description
Data Array of OutputNodePair

The nodes returned.

NodeList Array of Node

The information of the nodes returned.

BaselineId Long 1235667

The ID of the baseline.

Connection String odps_first

The name of the data source.

CronExpress String 00 00 00 * * ?

The cron expression.

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

DqcType Integer 1

Indicates whether the node is associated with Data Quality. Valid values: 0 and 1. The value 0 indicates that node is associated with Data Quality, and the value 1 indicates that the node is not associated with Data Quality.

FileType String ODPS_SQL

The type of the node.

Valid values:

6 (Shell node), 10 (ODPS SQL node), 11 (ODPS MR node), 23 (Data Integration node), 24 (ODPS Script node), 99 (zero-load node), 221 (PyODPS 2 node), 225 (ODPS Spark node), 227 (EMR Hive node), 228 (EMR Spark node), 229 (EMR Spark SQL node), 230 (EMR MR node), 239 (OSS object inspection node), 257 (EMR Shell node), 258 (EMR Spark Shell node), 259 (EMR Presto node), 260 (EMR Impala node), 900 (real-time synchronization node), 1089 (cross-tenant collaboration node), 1091 (Hologres development node), 1093 (Hologres SQL node), 1100 (assignment node), and 1221 (PyODPS 3 node).

NodeId Long 125677

The ID of the node.

NodeName String liux_test_n****

The name of the node.

OwnerId String 19337906836551

The ID of the node owner.

ParamValues String a=b

The values of the scheduling parameters configured for the node.

Priority Integer 1

The priority of the node. Valid values: 1, 3, 5, 7, and 8. A large value indicates a high priority. Default value: 1.

ProgramType String ODPS_SQL

The type of the node. This parameter is deprecated. For more information about node types, see the valid values of FileType.

ProjectId Long 33671

The ID of the workspace.

RelatedFlowId Long 1235655464

The ID of the associated workflow.

RepeatInterval Integer 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.

ResGroupName String Default resource group

The name of the resource group.

SchedulerType String NORMAL

The scheduling type of the node. Valid values:

  • NORAMAL: The node is an auto triggered node. The node is scheduled on a regular basis.
  • MANUAL: The node is a manually triggered node. The node is not scheduled on a regular basis.
  • PAUSE: The node is a frozen node. The system schedules the node on a regular basis but sets it to FAILURE when the system starts to schedule it.
  • SKIP: The node is a dry-run node. The system schedules the node on a regular basis but sets it to SUCCESS when the system starts to schedule it.
Output String test_0709_1.630003556_out

The output name of the current node.

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 SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD

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=ListNodesByOutput
&Outputs=aaaaa.1231412_out,bbbb.12313123_out
&ProjectEnv=PROD
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Output>test_0709_1.630003556_out</Output>
    <NodeList>
        <BaselineId>1235667</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>1235655464</RelatedFlowId>
        <SchedulerType>NORMAL</SchedulerType>
        <CronExpress>00 00 00 * * ?</CronExpress>
        <Repeatability>true</Repeatability>
        <OwnerId>19337906836551</OwnerId>
        <FileType>ODPS_SQL</FileType>
        <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
        <NodeId>125677</NodeId>
        <ProgramType>ODPS_SQL</ProgramType>
        <RepeatInterval>60</RepeatInterval>
    </NodeList>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD",
    "HttpStatusCode": 200,
    "Data": {
        "Output": "test_0709_1.630003556_out",
        "NodeList": {
            "BaselineId": 1235667,
            "ResGroupName": "Default resource group",
            "Description": "test",
            "NodeName": "liux_test_n****",
            "DqcType": 1,
            "Priority": 1,
            "ParamValues": "a=b",
            "Connection": "odps_first",
            "ProjectId": 33671,
            "RelatedFlowId": 1235655464,
            "SchedulerType": "NORMAL",
            "CronExpress": "00 00 00 * * ?",
            "Repeatability": true,
            "OwnerId": 19337906836551,
            "FileType": "ODPS_SQL",
            "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
            "NodeId": 125677,
            "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.