All Products
Search
Document Center

DataWorks:ListNodesByOutput

Last Updated:Oct 17, 2024

Queries nodes based on the output of the nodes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectEnvstringYes

The environment of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.

PROD
OutputsstringYes

The output name of the node. You can specify multiple output names. Separate them with commas (,).

aaaaa.1231412_out,bbbb.12313123_out

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID.

SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD
ErrorMessagestring

The error message.

The connection does not exist.
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Successboolean

Indicates whether the request was successful.

true
Dataarray<object>

The nodes returned.

OutputNodePairobject
Outputstring

The output name of the current node.

test_0709_1.630003556_out
NodeListarray<object>

The information about the nodes returned.

Nodeobject
SchedulerTypestring

The scheduling type of the node. Valid values:

  • NORMAL: The node is an auto triggered node. The scheduling system regularly runs the node.
  • MANUAL: The node is a manually triggered node. The scheduling system does not regularly run the node.
  • PAUSE: The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.
  • SKIP: The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.
NORMAL
RepeatIntervalinteger

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

60
Repeatabilityboolean

Indicates whether the node can be rerun.

true
FileTypestring

The node type. Valid values:

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

ODPS_SQL
ProjectIdlong

The workspace ID.

33671
ProgramTypestring

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

ODPS_SQL
Priorityinteger

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

1
OwnerIdstring

The owner ID.

19337906836551
Connectionstring

The name of the data source.

odps_first
ParamValuesstring

The scheduling parameters of the node.

a=b
RelatedFlowIdlong

The ID of the workflow to which the node belongs.

1235655464
DqcTypeinteger

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

1
BaselineIdlong

The baseline ID.

1235667
Descriptionstring

The description of the node.

test
NodeNamestring

The name of the node.

liux_test_n****
ResGroupNamestring

The name of the resource group.

DqcDescriptionstring

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

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

The CRON expression.

00 00 00 * * ?
NodeIdlong

The node ID.

125677

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": [
    {
      "Output": "test_0709_1.630003556_out",
      "NodeList": [
        {
          "SchedulerType": "NORMAL",
          "RepeatInterval": 60,
          "Repeatability": true,
          "FileType": "ODPS_SQL",
          "ProjectId": 33671,
          "ProgramType": "ODPS_SQL",
          "Priority": 1,
          "OwnerId": "19337906836551",
          "Connection": "odps_first",
          "ParamValues": "a=b",
          "RelatedFlowId": 1235655464,
          "DqcType": 1,
          "BaselineId": 1235667,
          "Description": "test",
          "NodeName": "liux_test_n****",
          "ResGroupName": "",
          "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
          "CronExpress": "00 00 00 * * ?",
          "NodeId": 125677
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history