調用ListNodes API分頁查詢資料開發節點列表-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

分頁擷取資料開發節點列表，也可以通過篩選條件對列表進行篩選查詢。

調試

您可以在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"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。