全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListNodes - 获取数据开发节点列表

更新时间:Dec 09, 2024

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdstring

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

12345
Scenestring

筛选条件:节点所在场景,在数据开发中对应左侧目录树的分区

可选值:

  • DataworksProject 项目目录
  • DataworksManualWorkflow 手动工作流
  • DataworksManualTask 手动任务
DataworksProject
ContainerIdstring

筛选条件:在指定容器内。填写容器 ID

860438872620113XXXX
Recurrencestring

筛选条件:调度类型

可选值:

  • Normal:正常执行任务。

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

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

Normal
RerunModestring

重跑属性。取值如下:

  • Allowed:运行成功或失败后皆可重跑。
  • FailureAllowed:运行成功后不可重跑,运行失败后可以重跑。
  • Denied:运行成功或失败皆不可重跑。
Allowed
PageNumberinteger

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

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

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

分页信息

TotalCountstring

满足条件的数据总条数。

42
PageSizestring

每页显示的条数

10
PageNumberstring

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

1
Nodesarray<object>

数据开发节点列表

nodeobject

数据开发节点信息

Descriptionstring

节点描述

节点描述
Namestring

节点名称

test
Idstring

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

860438872620113XXXX
ProjectIdstring

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

33233
Ownerstring

数据开发节点责任人

110755000425XXXX
CreateTimelong

数据开发节点创建时间戳

1722910655000
ModifyTimelong

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

1722910655000
DataSourceobject

数据源

Namestring

数据源名称

odps_first
Typestring

数据源类型

odps
TaskIdstring

调度任务 Id

88888888888
Tagsarray<object>

标签信息,暂未使用

tagobject

单个标签,暂未使用

Keystring

标签键

null
Valuestring

标签值

null
Strategyobject

调度策略

Timeoutinteger

超时时间

0
InstanceModestring

生成实例的模式

T+1
RerunModestring

允许重跑的模式

Allowed
RerunTimesinteger

重试次数

3
RerunIntervalinteger

重试时间间隔,单位毫秒

180000
Outputsobject

节点输出

Variablesarray<object>

变量列表

variableobject

变量元素

Namestring

变量名

output
ArtifactTypestring

制品类型

Variable
Scopestring

变量作用范围

枚举值:
  • NodeParameterNodeParameter
  • NodeContextNodeContext
  • WorkflowWorkflow
  • WorkspaceWorkspace
NodeParameter
Typestring

变量类型

枚举值:
  • NoKvVariableExpressionNoKvVariableExpression
  • ConstantConstant
  • PassThroughPassThrough
  • SystemSystem
  • NodeOutputNodeOutput
Constant
Valuestring

变量值

111
Idstring

变量 id

623731286945488XXXX
Nodeobject

变量所属节点

Outputstring

节点输出

860438872620113XXXX
NodeOutputsarray<object>

节点输出列表

nodeoutputobject

节点输出项

Datastring

节点输出

860438872620113XXXX
Tablesarray<object>

表列表

tableobject

表输出项

Guidstring

表 id

odps.autotest.test_output_table_1
Inputsobject

节点输入

Variablesarray<object>

变量列表

variableobject

变量元素

Namestring

变量名

input
ArtifactTypestring

制品类型

Variable
Scopestring

输入变量作用范围

枚举值:
  • WorkSpaceWorkSpace
  • NodeParameterNodeParameter
  • NodeContextNodeContext
  • WorkflowWorkflow
NodeParameter
Typestring

类型

枚举值:
  • NoKvVariableExpressionNoKvVariableExpression
  • ConstantConstant
  • PassThroughPassThrough
  • SystemSystem
  • NodeOutputNodeOutput
Constant
Valuestring

变量值

222
Idstring

变量 id

543211286945488XXXX
Nodeobject

变量所属节点

Outputstring

节点输出

623731286945488XXXX
NodeOutputsarray<object>

节点输出列表

nodeoutputobject

节点输出项

Datastring

节点输出

623731286945488XXXX
Tablesarray<object>

表列表

tableobject

表输出项

Guidstring

表 id

odps.autotest.test_output_table_1
Triggerobject

触发器

Typestring

触发器类型

可选值:

  • Scheduler 周期调度
  • Manual 手动触发
  • Steaming 流式任务
枚举值:
  • StreamingStreaming
  • SchedulerScheduler
  • ManualManual
Scheduler
Idstring

触发器 id

543680677872062XXXX
Cronstring

调度的 cron 表达式

00 00 00 * * ?
StartTimestring

触发器有效期开始时间

1970-01-01 00:00:00
EndTimestring

触发器有效期结束时间

9999-01-01 00:00:00
Timezonestring

时区

Asia/Shanghai
Scriptobject

脚本信息

Pathstring

脚本路径

root/demo
Runtimeobject

运行时

Commandstring

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

ODPS_SQL
Idstring

脚本 id

853573334108680XXXX
RuntimeResourceobject

资源组信息

ResourceGroupIdstring

资源组 id

S_resgrop_xxx
Recurrencestring

调度类型

可选值:

  • Normal:正常执行任务。

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

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

Normal

示例

正常返回示例

JSON格式

{
  "RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
  "PagingInfo": {
    "TotalCount": "42",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "节点描述",
        "Name": "test",
        "Id": "860438872620113XXXX",
        "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",
              "Id": "623731286945488XXXX",
              "Node": {
                "Output": "860438872620113XXXX"
              }
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "222",
              "Id": "543211286945488XXXX",
              "Node": {
                "Output": "623731286945488XXXX"
              }
            }
          ],
          "NodeOutputs": [
            {
              "Data": "623731286945488XXXX"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Trigger": {
          "Type": "Scheduler",
          "Id": "543680677872062XXXX",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00",
          "Timezone": "Asia/Shanghai"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_SQL"
          },
          "Id": "853573334108680XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_resgrop_xxx"
        },
        "Recurrence": "Normal"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-10-11OpenAPI 入参发生变更查看变更详情