ListNodesByOutput

Updated at:

Queries nodes by an exact match on the output of the nodes.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ProjectEnv

string

Yes

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

Outputs

string

Yes

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

aaaaa.1231412_out,bbbb.12313123_out

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID.

SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD

ErrorMessage

string

The error message.

The connection does not exist.

ErrorCode

string

The error code.

Invalid.Tenant.ConnectionNotExists

Success

boolean

Indicates whether the request was successful.

true

Data

array<object>

The nodes returned.

array<object>

Output

string

The output name of the current node.

test_0709_1.630003556_out

NodeList

array<object>

The list of node information corresponding to input and output.

object

SchedulerType

string

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

RepeatInterval

integer

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

60

Repeatability

boolean

Indicates whether the node can be rerun.

true

FileType

string

The file type. Different file types have different codes. For more information, see DataWorks nodes.

ODPS_SQL

ProjectId

integer

The workspace ID.

33671

ProgramType

string

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

ODPS_SQL

Priority

integer

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

1

OwnerId

string

The owner ID.

19337906836551

Connection

string

The name of the data source.

odps_source

ParamValues

string

The scheduling parameters of the node.

a=b

RelatedFlowId

integer

The ID of the workflow to which the node belongs.

1235655464

DqcType

integer

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

BaselineId

integer

The baseline ID.

1235667

Description

string

The description of the node.

test

NodeName

string

The name of the node.

liux_test_n****

ResGroupName

string

The name of the resource group.

Default Resource Group

DqcDescription

string

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]"}]

CronExpress

string

The CRON expression.

00 00 00 * * ?

NodeId

integer

The node ID.

125677

Examples

Success response

JSON format

{
  "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_source",
          "ParamValues": "a=b",
          "RelatedFlowId": 1235655464,
          "DqcType": 1,
          "BaselineId": 1235667,
          "Description": "test",
          "NodeName": "liux_test_n****",
          "ResGroupName": "Default Resource Group",
          "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.