AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

ListNodes - 获取数据开发节点列表

更新时间：
复制为 MD 格式
产品详情
我的收藏

分页获取数据开发节点列表，也可以通过筛选条件对列表进行筛选查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
ProjectId

integer

是

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。

12345
Scene

string

否

筛选条件：节点所在场景，如未指定则不填写，在数据开发中对应左侧目录树的分区可选值：

  • DataworksProject 项目目录

  • DataworksManualWorkflow 手动工作流

  • DataworksManualTask 手动任务。

DataworksProject
ContainerId

string

否

如未指定则不填写，筛选条件：在指定容器内。填写容器 ID，与资源组（ResourceGroupId）无关。

重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。

860438872620113XXXX
Recurrence

string

否

筛选条件：调度类型可选值：

  • Normal：正常执行任务。

  • Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。

  • Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为 0 秒），不会阻塞下游节点执行，也不会占用资源。

Normal
RerunMode

string

否

重跑属性，如不指定则不填写。取值如下：

  • Allowed：运行成功或失败后皆可重跑。

  • FailureAllowed：运行成功后不可重跑，运行失败后可以重跑。

  • Denied：运行成功或失败皆不可重跑。

Allowed
Name

string

否

节点名称，支持模糊查询

test
PageNumber

integer

否

请求的数据页数，用于翻页。

1
PageSize

integer

否

每页显示的条数，默认为 10 条，最大 100 条。

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求的 id。用于定位日志，排查问题。

2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX
PagingInfo

object

分页信息

TotalCount

string

满足条件的数据总条数。

42
PageSize

string

每页显示的条数

10
PageNumber

string

请求的数据页数，用于翻页。

1
Nodes

array<object>

数据开发节点列表

array<object>

数据开发节点信息

Description

string

节点描述

Node description

Name

string

节点名称

test
ProjectId

integer

DataWorks 工作空间的 ID，您可以登录 DataWorks 控制台，进入工作空间管理页面查看 ID。

33233
Owner

string

数据开发节点责任人

110755000425XXXX
CreateTime

integer

数据开发节点创建时间戳

1722910655000
ModifyTime

integer

数据开发节点最近修改时间戳

1722910655000
DataSource

object

数据源

Name

string

数据源名称

odps_first
Type

string

数据源类型

odps
TaskId

integer

调度任务 Id

88888888888
Tags

array<object>

标签信息，暂未使用

object

单个标签，暂未使用

Key

string

标签键

null
Value

string

标签值

null
Strategy

object

调度策略

Timeout

integer

超时时间

0
InstanceMode

string

生成实例的模式

  • T+1

  • Immediately

T+1
RerunMode

string

允许重跑的模式

  • Allowed

  • Denied

  • FailureAllowed

Allowed
RerunTimes

integer

重试次数

3
RerunInterval

integer

重试时间间隔，单位毫秒

180000
Outputs

object

节点输出

Variables

array<object>

变量列表

array<object>

变量元素

Name

string

变量名

output

ArtifactType

string

制品类型

Variable
Scope

string

变量作用范围

  • NodeParameter

  • NodeContext

  • Workflow

  • Workspace

NodeParameter
Type

string

变量类型

  • NoKvVariableExpression

  • Constant

  • PassThrough

  • System

  • NodeOutput

Constant
Value

string

变量值

111
Node

object

变量所属节点

Output

string

节点输出

860438872620113XXXX
Id

string

变量 id。

重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。

623731286945488XXXX
NodeOutputs

array<object>

节点输出列表

object

节点输出项

Data

string

节点输出

860438872620113XXXX
RefTableName

string

用于标识节点产出的目标数据表。该字段旨在提供易于理解的语义化名称，帮助用户快速识别输出内容，仅用于展示和备注，无实际逻辑约束。

testProject.testTableName
Tables

array<object>

表列表

object

表输出项

Guid

string

表 id

odps.autotest.test_output_table_1
Inputs

object

节点输入

Variables

array<object>

变量列表

array<object>

变量元素

Name

string

变量名

input
ArtifactType

string

制品类型

Variable
Scope

string

输入变量作用范围

  • WorkSpace

  • NodeParameter

  • NodeContext

  • Workflow

NodeParameter
Type

string

类型

  • NoKvVariableExpression

  • Constant

  • PassThrough

  • System

  • NodeOutput

Constant
Value

string

变量值

222
Node

object

变量所属节点

Output

string

节点输出

623731286945488XXXX
Id

string

变量 id。

重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。

543211286945488XXXX
NodeOutputs

array<object>

节点输出列表

object

节点输出项

Data

string

节点输出

623731286945488XXXX
RefTableName

string

用于标识节点产出的目标数据表。该字段旨在提供易于理解的语义化名称，帮助用户快速识别输出内容，仅用于展示和备注，无实际逻辑约束。

testProject.testTableName
Tables

array<object>

表列表

object

表输出项

Guid

string

表 id

odps.autotest.test_output_table_1
Trigger

object

触发器

Type

string

触发器类型

可选值：

  • Scheduler 周期调度

  • Manual 手动触发

  • Steaming 流式任务

Scheduler
Cron

string

调度的 cron 表达式

00 00 00 * * ?
StartTime

string

触发器有效期开始时间

1970-01-01 00:00:00
EndTime

string

触发器有效期结束时间

9999-01-01 00:00:00
Timezone

string

时区

Asia/Shanghai
Id

string

触发器 id。

重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。

543680677872062XXXX
Script

object

脚本信息

Path

string

脚本路径

root/demo
Runtime

object

运行时

Command

string

命令，用于区分节点类型。

ODPS_SQL
Id

string

脚本 id。

重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。

853573334108680XXXX
RuntimeResource

object

资源组信息

ResourceGroupId

string

资源组 id

123456XXX
ResourceGroup

string

资源组的标识（Identifier）。您可以调用 ListResourceGroups 接口获取资源组的标识（Identifier）。

S_res_group_XXXX
Recurrence

string

调度类型

可选值：

  • Normal：正常执行任务。

  • Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。

  • Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为 0 秒），不会阻塞下游节点执行，也不会占用资源。

Normal
Id

string

数据开发节点的唯一标识符。

重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。

860438872620113XXXX

示例

正常返回示例

JSON格式

{
  "RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
  "PagingInfo": {
    "TotalCount": "42",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description\n",
        "Name": "test",
        "ProjectId": 33233,
        "Owner": "110755000425XXXX",
        "CreateTime": 1722910655000,
        "ModifyTime": 1722910655000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": 88888888888,
        "Tags": [
          {
            "Key": "null",
            "Value": "null"
          }
        ],
        "Strategy": {
          "Timeout": 0,
          "InstanceMode": "T+1",
          "RerunMode": "Allowed",
          "RerunTimes": 3,
          "RerunInterval": 180000
        },
        "Outputs": {
          "Variables": [
            {
              "Name": "output\n",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "860438872620113XXXX"
              },
              "Id": "623731286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "222",
              "Node": {
                "Output": "623731286945488XXXX"
              },
              "Id": "543211286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "623731286945488XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Trigger": {
          "Type": "Scheduler",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00",
          "Timezone": "Asia/Shanghai",
          "Id": "543680677872062XXXX"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_SQL"
          },
          "Id": "853573334108680XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "123456XXX",
          "ResourceGroup": "S_res_group_XXXX"
        },
        "Recurrence": "Normal",
        "Id": "860438872620113XXXX"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetNode - 获取数据开发节点详情下一篇：ListNodeDependencies - 获取数据开发节点的依赖节点