ListInstances 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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectEnv	string	必須	実行環境。有効な値: PROD: 本番環境。 DEV: 開発環境。列挙値: PROD : 本番環境。 DEV : 開発環境。	PROD
NodeId	integer	任意	ノードの ID。 ListNodes を呼び出してノード ID を取得できます。	100000000000
NodeName	string	任意	ノード名。 ListNodes を呼び出してノード名を取得できます。	openmr_8****
Owner	string	任意	オーナーの ID。ワークスペース管理者の UID です。Alibaba Cloud マネジメントコンソールにログインし、ストレージ管理ページのセキュリティ設定項目セクションで UID を確認できます。	193379****
ProjectId	integer	必須	ワークスペースの ID。 ListProjects を呼び出してワークスペース ID を取得できます。	12345
BizName	string	任意	ワークフローの名前。 ListBusiness を呼び出してワークフロー情報を取得できます。フォーマット: yyyy-MM-dd HH:mm:ss。	test_bizName
ProgramType	string	任意	ノードタイプ。 ListNodes を呼び出してノードタイプを取得できます。	ODPS_SQL
PageNumber	integer	任意	ページ番号。最小値: 1。最大値: 100。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10
DagId	integer	任意	DAG ID。DagId は、データバックフィル用の RunCycleDagNodes 、スモークテスト用の RunSmokeTest 、手動ワークフロー用の RunManualDagNodes などのオペレーションによって返される DagId を指定できます。	11111
Bizdate	string	任意	インスタンスリストを取得する対象の日付。フォーマット: yyyy-MM-dd HH:mm:ss。	2020-02-02 00:00:00
BeginBizdate	string	任意	インスタンスリストを取得する開始日。フォーマット: yyyy-MM-dd HH:mm:ss。	2020-02-02 00:00:00
EndBizdate	string	任意	インスタンスリストを取得する終了日。フォーマット: yyyy-MM-dd HH:mm:ss。	2020-02-03 00:00:00
Status	string	任意	ノードのステータス。有効な値: NOT_RUN: ノードは実行されていません。 WAIT_TIME: ノードはスケジュール時刻 (DueTime または CycTime) の到達を待っています。 WAIT_RESOURCE: ノードはリソースを待っています。 RUNNING: ノードは実行中です。 CHECKING: ノードはデータ検証のため Data Quality に送信されました。 CHECKING_CONDITION: ノードはブランチ条件の検証中です。 FAILURE: 実行に失敗しました。 SUCCESS: 正常に実行されました。	NOT_RUN
OrderBy	string	任意	返される結果のソートルール。有効な値: CREATE_TIME_DESC: 作成時間の降順でソートされます。 INSTANCE_ID_DESC: デフォルト値。インスタンス ID の降順でソートされます。列挙値: CREATE_TIME_DESC : 作成時間の降順でソートされます。 INSTANCE_ID_DESC : インスタンス ID の降順でソートされます。	INSTANCE_ID_DESC

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
HttpStatusCode	integer	HTTP 状態コード。	200
RequestId	string	リクエスト ID。この ID を使用してログの特定や問題のトラブルシューティングを行えます。	E6F0DBDD-5AD****
ErrorMessage	string	エラーメッセージ。	The project does not exist
ErrorCode	string	エラーコード。	Invalid.Tenant.ProjectNotExists
Success	boolean	リクエストが成功したかどうかを示します。有効な値: true: リクエストは成功しました。 false: リクエストは失敗しました。	true
Data	object	インスタンスのリスト。
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10
TotalCount	integer	インスタンスの総数。	66
Instances	array<object>	インスタンス情報。フォーマット: yyyy-MM-dd HH:mm:ss。
	object	返されたデータ。
Status	string	照会対象のインスタンスのデータタイムスタンプを指定します。yyyy-MM-dd HH:mm:ss 形式で指定してください。	NOT_RUN
CycTime	integer	返されたエラーメッセージ。	1590422400000
BeginRunningTime	integer	インスタンスの実行開始時刻。	1590416703313
FinishTime	integer	ワークスペース管理者が使用する Alibaba Cloud アカウントの ID。Alibaba Cloud 管理コンソールにログインし、アカウントセンターの「セキュリティ設定」ページで確認できます。	1590416703313
ErrorMessage	string	インスタンスの実行に使用されたアカウント名。たとえば、データのバックフィルを実行するために Test というアカウントを使用した場合、このパラメーターの値は Test になります。	error message
CreateTime	integer	ノードの失敗後の再実行間隔（ミリ秒単位）。	1590416703313
DagId	integer	インスタンスがリソースの確保を待機し始めた時刻。	33845
Priority	integer	インスタンスの総数。	1
TaskType	string	インスタンスに関する情報。	NORMAL(0)
ParamValues	string	Data Quality におけるノードに関連付けられたテーブルおよびパーティションフィルター式。	bizdate=$bizdate tbods=$tbods
Connection	string	ノードの再実行可能回数。このパラメーターの値は空でも、または 0 以上の整数でも構いません。値が空の場合、再実行可能回数は未指定です。値が 0 の場合、ノードは再実行できません。値が正の整数（例：n）の場合、ノードは n 回再実行できます。たとえば、値が 1 の場合、ノードは 1 回再実行でき、値が 2 の場合、ノードは 2 回再実行できます。	odps_source
BaselineId	integer	ワークフローのタイプ。有効な値： DAILY：自動トリガー型ノードを実行するワークフロー。 MANUAL：手動トリガー型ノードを実行するワークフロー。 SMOKE_TEST：スモークテストを実行するワークフロー。 SUPPLY_DATA：データのバックフィルを実行するワークフロー。	123123
DqcType	integer	ノードのステータスです。有効な値： NOT_RUN：ノードは実行されていません。 WAIT_TIME：ノードはスケジュール実行時刻の到着を待っています。 WAIT_RESOURCE：ノードはリソースの確保を待っています。 RUNNING：ノードは実行中です。 CHECKING：Data Quality によるノードのデータ品質チェックが実行中です。 CHECKING_CONDITION：ノードのブランチ条件チェックが実行中です。 FAILURE：ノードの実行に失敗しました。 SUCCESS：ノードは正常に実行されました。	1
DagType	string	インスタンスのデータタイムスタンプ。ほとんどの場合、インスタンスの実行時刻の 1 日前となります。	DAILY
BusinessId	integer	ノードが属するワークフローの ID。	123
TaskRerunTime	integer	ワークスペースの ID。ワークスペースの ID を照会するには、 ListProjects 操作を呼び出してください。	0
ModifyTime	integer	ワークフローの名前。ワークフローの名前を照会するには、 ListBusiness 操作を呼び出してください。	1590416703313
Repeatability	boolean	ノードのステータスです。有効な値： NOT_RUN：ノードは実行されていません。 WAIT_TIME：ノードはスケジュール実行時刻の到着を待っています。 WAIT_RESOURCE：ノードはリソースの確保を待っています。 RUNNING：ノードは実行中です。 CHECKING：Data Quality によるノードのデータ品質チェックが実行中です。 CHECKING_CONDITION：ノードのブランチ条件チェックが実行中です。 FAILURE：ノードの実行に失敗しました。 SUCCESS：ノードは正常に実行されました。	true
RepeatInterval	integer	ノードのスケジューリングタイプ。有効な値： NORMAL(0)：自動トリガー型ノード。スケジューリングシステムが定期的にノードを実行します。 MANUAL(1)：手動トリガー型ノード。スケジューリングシステムはノードを定期的に実行しません。 PAUSE(2)：凍結ノード。スケジューリングシステムは定期的にノードを実行しますが、実行開始時にノードのステータスを「失敗」と設定します。 SKIP(3)：ドライランノード。スケジューリングシステムは定期的にノードを実行しますが、実行開始時にノードのステータスを「成功」と設定します。 SKIP_UNCHOOSE(4)：一時的なワークフロー内の未選択ノード。このタイプのノードは一時的なワークフロー内でのみ存在し、スケジューリングシステムは実行開始時にノードのステータスを「成功」と設定します。 SKIP_CYCLE(5)：週または月単位でスケジュールされ、スケジュール実行時刻の到着を待っているノード。スケジューリングシステムは定期的にノードを実行しますが、実行開始時にノードのステータスを「成功」と設定します。 CONDITION_UNCHOOSE(6)：祖先のブランチノードによって選択されず、ドライランノードとして実行されるノード。 REALTIME_DEPRECATED(7)：リアルタイムで生成されたインスタンスを持つが非推奨となったノード。スケジューリングシステムはノードのステータスを「成功」と設定します。	60000
InstanceId	integer	返すページのページ番号。最小値：1。最大値：100。	1234
BeginWaitResTime	integer	ノードの実行停止時刻。	1590416703313
RelatedFlowId	integer	ノードのタイプ。ノードのタイプを照会するには、 ListNodes 操作を呼び出してください。	123456
Bizdate	integer	1 ページあたりに返されるエントリ数。デフォルト値：10。最大値：100。この操作では、返されるインスタンスの並べ替え方法を指定できません。デフォルトでは、インスタンスは作成時刻の降順で並べ替えられます。	1590336000000
NodeName	string	ワークフローの ID。	kzh
BeginWaitTimeTime	integer	リクエストの ID。この ID を使用してログを特定し、問題をトラブルシューティングできます。	1590416703313
DqcDescription	string	実行する操作。	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
NodeId	integer	ワークスペースの環境です。有効な値：PROD、DEV。PROD は本番環境を、DEV は開発環境を示します。	33115
CreateUser	string	ノードの ID。ノードの ID を照会するには、 ListNodes 操作を呼び出してください。	Test

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The project does not exist.",
  "ErrorCode": "Invalid.Tenant.ProjectNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "CycTime": 1590422400000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "ErrorMessage": "error message",
        "CreateTime": 1590416703313,
        "DagId": 33845,
        "Priority": 1,
        "TaskType": "NORMAL(0)",
        "ParamValues": "bizdate=$bizdate tbods=$tbods",
        "Connection": "odps_source",
        "BaselineId": 123123,
        "DqcType": 1,
        "DagType": "DAILY",
        "BusinessId": 123,
        "TaskRerunTime": 0,
        "ModifyTime": 1590416703313,
        "Repeatability": true,
        "RepeatInterval": 60000,
        "InstanceId": 1234,
        "BeginWaitResTime": 1590416703313,
        "RelatedFlowId": 123456,
        "Bizdate": 1590336000000,
        "NodeName": "kzh",
        "BeginWaitTimeTime": 1590416703313,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "NodeId": 33115,
        "CreateUser": "Test"
      }
    ]
  }
}

エラーコード

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

変更履歴

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