ListNodeDependencies によるノード子孫依存関係の取得 - DataWorks - Alibaba Cloud - DataWorks

指定された DataStudio ノードの依存関係ノードをページネーション付きで取得します。

今すぐお試しください

この 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 を取得できます。このパラメーターは、この API 呼び出しの対象となる DataWorks ワークスペースを指定します。	10001
Id	string	必須	DataStudio ノードの一意の識別子。重要このフィールドは、8.0.0 より前の SDK バージョンでは Long 型でしたが、SDK 8.0.0 以降では String 型に変更されました。この変更は通常の SDK の使用量に影響を与えず、パラメーターは引き続き SDK で定義された型で返されます。SDK バージョン 8.0.0 をまたいでスペックアップする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があり、データの型を手動で修正する必要があります。	860438872620113XXXX
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値: 1。	1
PageSize	integer	任意	ページサイズ。デフォルト値: 10。最大値: 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。	204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
PagingInfo	object	ページネーション情報。
TotalCount	string	条件を満たすレコードの総数。	90
PageSize	string	1 ページあたりのレコード数。	10
PageNumber	string	リクエストされたデータのページ番号。ページネーションに使用されます。	1
Nodes	array<object>	クエリによって返される依存ノードのリスト。
	array<object>	依存ノードリストの要素。
Description	string	ノードの説明。	スクリプトの説明
Name	string	データ開発ノードの名前。	Node name
ProjectId	integer	データ開発ノードが属するワークスペースの ID。	65133
Owner	string	データ開発ノードのオーナー。	110755000425XXXX
CreateTime	integer	データ開発ノードが作成されたタイムスタンプ。	1724505917000
ModifyTime	integer	データ開発ノードが最後に変更されたタイムスタンプ。	1724505917000
DataSource	object	データソース。
Name	string	データソースの名前。	odps_first
Type	string	データソースのタイプ。	odps
TaskId	integer	スケジュールタスクの ID。	580667964888595XXXX
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	変数に対応するノード出力。	463497880880954XXXX
Id	string	変数の ID。重要このフィールドは、8.0.0 より前の SDK バージョンでは Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK 使用には影響しません。パラメーターは引き続き SDK で定義された型で返されます。 SDK バージョン 8.0.0 をまたいでアップグレードする場合のみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があるため、手動でデータの型を修正する必要があります。	543217824470354XXXX
NodeOutputs	array<object>	ノード出力のリスト。
	object	ノード出力エントリ。
Data	string	ノード出力。	463497880880954XXXX
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	範囲。有効な値: NodeParameter NodeContext Workflow Workspace	NodeParameter
Type	string	タイプ。有効な値: NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	変数の値。	111
Node	object	変数が属するノード。
Output	string	ノード出力。	860438872620113XXXX
Id	string	変数の ID。重要このフィールドは、SDK 8.0.0 より前のバージョンでは Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK の使用には影響しません。パラメーターは引き続き SDK で定義された型で返されます。 SDK バージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があり、データの型を手動で修正する必要があります。	543218872620113XXXX
NodeOutputs	array<object>	ノード出力のリスト。
	object	ノード出力エントリ。
Data	string	ノード出力。	860438872620113XXXX
RefTableName	string	ノード出力を識別するターゲットデータテーブル。このフィールドは理解しやすいセマンティック名を提供し、出力内容を迅速に特定するのに役立ちます。表示およびアノテーション目的でのみ使用され、実際の論理制約はありません。	testProject.testTableName
Tables	array<object>	テーブルのリスト。
	object	テーブル出力エントリ。
Guid	string	テーブルの ID。	odps.autotest.test_output_table_1
Trigger	object	トリガー。
Type	string	トリガーのタイプ。有効な値: Scheduler: 時間指定スケジューリング。 Manual: 手動スケジュール。 Streaming: ストリーミングスケジューラ。	Scheduler
Cron	string	スケジューリング用の cron 式。	00 00 00 * * ?
StartTime	string	スケジュールが有効になる開始時刻。フォーマット: yyyy-MM-dd HH:mm:ss。	1970-01-01 00:00:00
EndTime	string	スケジュールの有効期限が切れる終了時刻。フォーマット: yyyy-MM-dd HH:mm:ss。	9999-01-01 00:00:00
Timezone	string	タイムゾーンの時間。	Asia/Shanghai
Id	string	トリガーの一意識別子。重要このフィールドは、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。	S_res_group_XXXX_XXXX
Recurrence	string	スケジューリングのタイプ。有効な値: Normal: ノードは正常に実行されます。 Pause: ノードは一時停止され、そのノードに依存する下流ノードの実行をブロックします。 Skip: ノードはドライランに設定されます。システムは成功結果 (実行時間 0 秒) を直接返し、下流ノードの実行をブロックせず、リソースも消費しません。	Normal
Id	string	DataStudio ノードの一意識別子。重要このフィールドは、SDK 8.0.0 より前のバージョンでは Long 型でしたが、SDK 8.0.0 以降では String 型になりました。この変更は通常の SDK の使用には影響しません。パラメーターは引き続き SDK で定義された型で返されます。 SDK バージョン 8.0.0 をまたいでアップグレードする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があり、データの型を手動で修正する必要があります。	723932906364267XXXX

例

成功レスポンス

JSONJSON

{
  "RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
  "PagingInfo": {
    "TotalCount": "90",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description",
        "Name": "Node name",
        "ProjectId": 65133,
        "Owner": "110755000425XXXX",
        "CreateTime": 1724505917000,
        "ModifyTime": 1724505917000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": 0,
        "Tags": [
          {
            "Key": "null",
            "Value": "null"
          }
        ],
        "Strategy": {
          "Timeout": 0,
          "InstanceMode": "T+1",
          "RerunMode": "Allowed",
          "RerunTimes": 3,
          "RerunInterval": 180000
        },
        "Outputs": {
          "Variables": [
            {
              "Name": "output",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "463497880880954XXXX"
              },
              "Id": "543217824470354XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "463497880880954XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "860438872620113XXXX"
              },
              "Id": "543218872620113XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX",
              "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": "S_res_group_XXXX_XXXX"
        },
        "Recurrence": "Normal",
        "Id": "723932906364267XXXX"
      }
    ]
  }
}

エラーコード

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

変更履歴

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