すべてのプロダクト
Search
ドキュメントセンター

DataWorks:ListNodes

最終更新日:Mar 21, 2026

ワークスペースの ID です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

Owner

string

任意

ノードの説明です。

193379****

BizName

string

任意

返されたエラーコードです。

test_bizName

ProgramType

string

任意

実行する操作です。値を ListNodes に設定します。

ODPS_SQL

PageNumber

integer

任意

ページ番号です。最小値:1、最大値:100。

1

PageSize

integer

任意

1 ページあたりのエントリ数です。デフォルト値:10、最大値:100。

10

ProjectId

integer

必須

オーナーの ID です。

1234

ProjectEnv

string

必須

ノードが実行される環境です。有効な値:DEV および PROD。

PROD

NodeName

string

任意

ノードに関連付けられたベースラインの ID です。

liux_test_n****

SchedulerType

string

任意

スケジューリングタイプです。有効な値:

  • NORMAL:ノードは予定通りスケジュールされます。

  • PAUSE:ノードは一時停止されます。

  • SKIP:ノードはドライランされます。ドライランノードはスケジュールどおり開始されますが、システムは実行開始時にノードのステータスを成功に設定します。

NORMAL

レスポンスフィールド

フィールド

型

説明

例

object

返された結果です。

HttpStatusCode

integer

ノードの実行に失敗した後の再実行間隔です。

200

RequestId

string

ノードのリストです。

E6F0DBDD-5AD****

ErrorMessage

string

返されたページのページ番号です。

The connection does not exist.

ErrorCode

string

返された HTTP ステータスコードです。

Invalid.Tenant.ConnectionNotExists

Success

boolean

ノードを再実行できるかどうかを示します。

true

Data

object

ノードです。

PageNumber

integer

ノードの名前です。

1

PageSize

integer

返された cron 式です。

10

TotalCount

integer

ワークフローの名前です。

66

Nodes

array<object>

ノードに関する情報です。

object

返された結果です。

SchedulerType

string

ノードのタイプです。ListNodes 操作を呼び出してノードのタイプを照会できます。

NORMAL

RepeatInterval

integer

ワークスペースの環境です。有効な値:PROD および DEV。

60

Repeatability

boolean

ノードの名前です。

true

RepeatMode

integer

再実行モードです。値 0 は、失敗時のみ再実行できることを示します。値 1 は、すべての場合に再実行できることを示します。値 2 は、すべての場合に再実行できないことを示します。

1

ProjectId

integer

ノードに関する情報です。

33671

ProgramType

string

返されたエラーメッセージです。

ODPS_SQL

Priority

integer

オーナーの ID です。

1

OwnerId

string

追加パラメーターです。

19337906836551

Connection

string

リソースグループの名前です。

odps_source

ParamValues

string

ノードのタイプです。

a=b

RelatedFlowId

integer

Data Quality でノードに関連付けられているテーブルおよびパーティションフィルター式です。

1231123

DqcType

integer

接続文字列です。

1

BaselineId

integer

返されるページのページ番号です。最小値:1、最大値:100。

123456

Description

string

ノードを実行する優先度です。有効な値:1、3、5、7、8。

test

NodeName

string

返されたノードの総数です。

liux_test_n****

ResGroupName

string

ワークフローの ID です。

默认资源组

BusinessId

integer

実行する操作です。値を ListNodes に設定します。

123

DqcDescription

string

オーナーの ID です。

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

CronExpress

string

ワークフローの名前です。

00 00 00 * * ?

NodeId

integer

ノードのタイプです。ListNodes 操作を呼び出してノードのタイプを照会できます。

1234

ResGroupIdentifier

string

リソースグループの識別子です。

group_123

FileType

integer

ファイルタイプによってコードが異なります。詳細については、「DataWorks ノードコレクション」をご参照ください。また、ListFileType インターフェイスを呼び出してファイルのコードタイプを照会することもできます。

10

FileId

integer

ファイル ID です。ListFiles 操作を呼び出して ID を照会できます。

**

警告 このフィールドは非推奨です。

20

FileVersion

integer

ファイルの最新バージョン番号です。

3

DeployDate

integer

ノードがデプロイされたタイムスタンプです。単位:ミリ秒。

1734537600000

CreateTime

integer

ノードが作成されたタイムスタンプです。単位:ミリ秒。

1593879116000

ModifyTime

integer

ノードが変更されたタイムスタンプです。単位:ミリ秒。

1593879116000

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "RepeatInterval": 60,
        "Repeatability": true,
        "RepeatMode": 1,
        "ProjectId": 33671,
        "ProgramType": "ODPS_SQL",
        "Priority": 1,
        "OwnerId": "19337906836551",
        "Connection": "odps_source",
        "ParamValues": "a=b",
        "RelatedFlowId": 1231123,
        "DqcType": 1,
        "BaselineId": 123456,
        "Description": "test",
        "NodeName": "liux_test_n****",
        "ResGroupName": "默认资源组",
        "BusinessId": 123,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "CronExpress": "00 00 00 * * ?",
        "NodeId": 1234,
        "ResGroupIdentifier": "group_123",
        "FileType": 10,
        "FileId": 20,
        "FileVersion": 3,
        "DeployDate": 1734537600000,
        "CreateTime": 1593879116000,
        "ModifyTime": 1593879116000
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。