DataStudio ノードクエリ用の ListNodes API リファレンス - DataWorks - Alibaba Cloud - DataWorks

ページネーションを使用してデータ開発ノードのリストを取得し、指定された条件によるフィルターをサポートします。

今すぐお試しください

この 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

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID。DataWorks コンソールにログインし、ワークスペース構成ページに移動してワークスペース ID を取得できます。	12345
Scene	string	任意	ノードが存在するシーン。指定しない場合は、このパラメーターを空のままにします。このパラメーターは、DataStudio の左側のナビゲーションウィンドウのパーティションに対応します。有効な値: DataworksProject: プロジェクトフォルダ。 DataworksManualWorkflow: 手動ワークフロー。 DataworksManualTask: 手動ノード。	DataworksProject
ContainerId	string	任意	指定しない場合は、このパラメーターを空のままにします。フィルター条件: 指定されたコンテナ内。コンテナ ID を指定します。このパラメーターはリソースグループ (ResourceGroupId) とは無関係です。	860438872620113XXXX
Recurrence	string	任意	フィルター条件: スケジューリングタイプ。有効な値: Normal: ノードは法線通り実行されます。 Pause: ノードのステータスが一時停止にセットされ、現在のノードに依存する下流ノードの実行がブロックされます。 Skip: ノードのステータスがドライランにセットされます。システムは成功結果 (実行時間 0 秒) を直接返し、下流ノードの実行をブロックせず、リソースも消費しません。	法線
RerunMode	string	任意	再実行プロパティ。指定しない場合、このパラメーターは空のままになります。有効な値: Allowed: ノードは、実行の成否にかかわらず再実行できます。 FailureAllowed: ノードは、失敗した実行後のみ再実行でき、成功した実行後は再実行できません。 Denied: ノードは、実行の成否にかかわらず再実行できません。	Allowed
Name	string	任意	ノード名。あいまい一致がサポートされています。	test
PageNumber	integer	任意	ページネーションのページ番号。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。ログの特定および問題のトラブルシューティングに使用されます。	2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX
PagingInfo	object	ページネーション情報。
TotalCount	string	条件を満たすレコードの総数。	42
PageSize	string	1 ページあたりのレコード数。	10
PageNumber	string	ページネーションのページ番号。	1
Nodes	array<object>	データ開発ノードのリスト。
	array<object>	データ開発ノード情報。
Description	string	ノードの説明。	スクリプトの説明
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
RerunMode	string	再実行を許可するかどうかを指定するモード。	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。重要このフィールドは、8.0.0 より前の SDK バージョンでは Long 型でしたが、SDK 8.0.0 以降では String 型になっています。この変更は通常の SDK の使用に影響を与えず、パラメーターは引き続き SDK で定義された型で返されます。SDK バージョン 8.0.0 をまたいでアップグレードする場合のみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があるため、手動でデータの型を修正する必要があります。	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。重要このフィールドは、SDK バージョン 8.0.0 より前では Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK の使用量には影響せず、パラメーターは引き続き SDK で定義されたデータの型で返されます。SDK バージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があるため、手動でデータの型を修正する必要があります。	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	トリガーの有効期間の開始時刻。フォーマットは `yyyy-MM-dd HH:mm:ss` です。例: `1970-01-01 00:00:00`。この例にはタイムゾーン識別子は含まれていません。	1970-01-01 00:00:00
EndTime	string	トリガーの有効期間の終了時刻。フォーマットは `yyyy-MM-dd HH:mm:ss` です。例: `9999-01-01 00:00:00`。この例にはタイムゾーン識別子は含まれていません。	9999-01-01 00:00:00
Timezone	string	タイムゾーン。	Asia/Shanghai
Id	string	トリガーの ID。重要このフィールドは、SDK バージョン 8.0.0 より前では Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK の使用量には影響せず、パラメーターは引き続き SDK で定義されたデータの型で返されます。SDK バージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があるため、手動でデータの型を修正する必要があります。	543680677872062XXXX
Script	object	スクリプトのフォーマット。
Path	string	スクリプトのパス。	root/demo
Runtime	object	ランタイムの時間。
Command	string	ノードタイプを区別するために使用されるコマンド。	ODPS_SQL
Id	string	スクリプトの ID。重要このフィールドは、SDK バージョン 8.0.0 より前では Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK の使用量には影響せず、パラメーターは引き続き SDK で定義されたデータの型で返されます。SDK バージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があるため、手動でデータの型を修正する必要があります。	853573334108680XXXX
RuntimeResource	object	リソースグループのフォーマット。
ResourceGroupId	string	リソースグループの ID。	123456XXX
ResourceGroup	string	リソースグループの識別子。 ListResourceGroups 操作を呼び出して、リソースグループ識別子を取得できます。	S_res_group_XXXX
Recurrence	string	スケジューリングタイプ。	Normal
Id	string	データ開発ノードの一意の識別子。重要このフィールドは、SDK バージョン 8.0.0 より前では Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK の使用量には影響せず、パラメーターは引き続き SDK で定義されたデータの型で返されます。SDK バージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があるため、手動でデータの型を修正する必要があります。	860438872620113XXXX

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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