ListTaskInstances API リファレンス - DataWorks - Alibaba Cloud - DataWorks

ノードインスタンスをページごとに一覧表示し、条件によるフィルターをサポートします。

操作説明

この API オペレーションを使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

今すぐお試しください

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

get

*タスクインスタンス。

acs:dataworks:{#regionId}:{#accountId}:taskinstance/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	プロジェクトの ID。	100
Bizdate	integer	必須	業務日。通常、期間インスタンスのスケジュール時刻の前日の 00:00:00 になります。値は 1743350400000 などのミリ秒レベルのタイムスタンプです。	1710239005403
TaskId	integer	任意	対応するノードの ID。	1234
TaskIds	array	任意	ノード ID のリスト。このパラメーターを使用して、複数のノードのインスタンスをバッチでクエリできます。
	integer	任意	ノードの ID。	1234
TaskName	string	任意	対応するノードの名前。あいまい一致がサポートされています。	SQL ノード
Owner	string	任意	ノードオーナーのアカウント ID。	1000
TaskType	string	任意	ノードタイプ。各ノードの TaskType の値については、「DataWorks ノード」を参照してください。	ODPS_SQL
RuntimeResource	string	任意	スケジュールリソース情報。スケジュールリソースグループの識別子を指定します。	S_res_グループ_524258031846018_1684XXXXXXXXX
WorkflowId	integer	任意	インスタンスが属するワークフローの ID。	1234
UnifiedWorkflowInstanceId	integer	任意	統一ワークフローインスタンス ID。単一のトリガー配下の同じ業務日内のすべてのインスタンスは、このフィールドに対して同じ値を共有します。	1234
WorkflowInstanceType	string	任意	インスタンスが属するワークフローインスタンスのタイプ。有効な値: SmokeTest: テスト。 Manual: 手動ノード。 SupplementData: データバックフィル。 ManualWorkflow: 手動ワークフロー。 Normal: 法線期間スケジューリング。 TriggerWorkflow: トリガーベースのワークフロー。列挙値: SmokeTest : テスト。 TriggerWorkflow : トリガーベースのワークフロー。 Manual : 手動ノード。 SupplementData : データバックフィル。 ManualWorkflow : 手動ワークフロー。 Normal : 定期スケジューリング。	法線
WorkflowInstanceId	integer	任意	インスタンスが属するワークフローインスタンスの ID。	1234
ProjectEnv	string	任意	プロジェクト環境。有効な値: Prod: 本番環境。 Dev: 開発環境。列挙値: Prod : 本番環境。 Dev : 開発環境。	Prod
Id	integer	任意	インスタンスの ID。インスタンスが再実行された場合、このパラメーターを指定すると、再実行を含む履歴情報が返されます。RunNumber を使用して、各履歴 Record を区別できます。	1234
Ids	array	任意	インスタンス ID のリスト。このパラメーターを使用して、複数のインスタンスをバッチでクエリできます。
	integer	任意	インスタンスの ID。	1234
TriggerType	string	任意	トリガータイプ。有効な値: Scheduler: 期間スケジューリングによるトリガー。 Manual: 手動トリガー。列挙値: Scheduler : 期間スケジューリングによるトリガー。 Manual : 手動トリガー。	法線
TriggerRecurrence	string	任意	トリガー時間の実行モード。このパラメーターは、TriggerType が Scheduler に設定されている場合にのみ有効です。有効な値: Pause: 一時停止。 Skip: ドライラン。 Normal: 法線実行。列挙値: Pause : 一時停止。 Skip : ドライラン。 Normal : 法線実行。	法線
SortBy	string	任意	ソートフィールド。スケジュール時刻や開始時刻などのフィールドをサポートします。フォーマットは「ソートフィールド + ソート順序 (Desc/Asc)」です。Asc は省略できます。有効な値: `TriggerTime (Desc/Asc)` `StartedTime (Desc/Asc)` `FinishedTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` デフォルト値: `Id Desc`	Id Desc
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 500。	10
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値: 1。	1
Status	string	任意	インスタンスのステータス。有効な値: `NotRun`: 未実行。 `Running`: 実行中。 `Failure`: 失敗した。 `Success`: 成功。 `WaitTime`: スケジュール時刻の待機中。 `WaitResource`: リソースの待機中。	Success
Filter	string	任意	フィルター。値は JSON フォーマットです。複数のフィルター条件は AND 論理で結合されます。現在サポートされているフィールド: `startedTimeStart, startedTimeEnd, finishedTimeStart, finishedTimeEnd, createTimeStart, createTimeEnd`	{ "startedTimeStart": "1763481600000", "startedTimeEnd": "1763481600000", "finishedTimeStart": "1763481600000", "finishedTimeEnd": "1763481600000", "createTimeStart": "1763481600000", "createTimeEnd": "1763481600000" }

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。ログの特定および問題のトラブルシューティングに使用されます。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	ページネーションフォーマット。
TaskInstances	array<object>	タスクインスタンスのリスト。
	array<object>
TaskId	integer	対応するノードの ID。	1234
TaskType	string	対応するノードのタイプ。	ODPS_SQL
TaskName	string	対応するノードの名前。	SQL ノード
Description	string	スクリプトの説明。	test
WorkflowId	integer	インスタンスが属するワークフローの ID。	1234
WorkflowName	string	インスタンスが属するワークフローの名前。	テストワークフロー
TriggerType	string	トリガータイプ。有効な値: Scheduler: スケジューリング周期によってトリガーされます。 Manual: 手動でトリガーされます。	Scheduler
TriggerRecurrence	string	トリガーされる時間の実行モード。このパラメーターは、TriggerType が Scheduler にセットされている場合に有効になります。有効な値: Pause: 一時停止。 Skip: ドライラン。 Normal: 法線実行。	法線
WorkflowInstanceId	integer	インスタンスが属するワークフローインスタンスの ID。	1234
UnifiedWorkflowInstanceId	integer	統一ワークフローインスタンス ID。単一のトリガー配下の同じ業務日内のすべてのインスタンスは、このフィールドに対して同じ値を共有します。	1234
WorkflowInstanceType	string	インスタンスが属するワークフローインスタンスのタイプ。有効な値: SmokeTest: スモークテスト。 SupplementData: データバックフィル。 Manual: 手動でトリガーされます。 ManualWorkflow: 手動ワークフロー。 Normal: 法線期間スケジューリング。 ManualFlow: 手動でトリガーされるワークフロー。	法線
Timeout	integer	ノード実行のタイムアウト期間 (秒単位)。注意: スケジューリングシステムは、設定された値を最も近い時間に丸めます。	3600
RerunMode	string	ノードの再実行構成。有効な値: AllDenied: 成否にかかわらず再実行は許可されません。 FailureAllowed: 失敗した場合にのみ再実行が許可されます。 AllAllowed: 成否にかかわらず再実行が許可されます。	AllAllowed
RunNumber	integer	現在の実行番号。デフォルトでは 1 から始まります。	1
PeriodNumber	integer	期間番号。インスタンスがその日のどのスケジューリング周期に属するかを示します。	1
BaselineId	integer	ベースライン ID。	1234
Priority	integer	ノードの実行優先度。最小値: 1。最大値: 8。値が大きいほど優先度が高くなります。デフォルト値: 1。	1
RuntimeResource	object	インスタンスに関連付けられたリソースグループフォーマット。
ResourceGroupId	string	ノードに設定されたスケジュールリソースグループの識別子。	S_res_グループ_524258031846018_1684XXXXXXXXX
Image	string	ノードに設定されたイメージ ID。	i-xxxxxx
Cu	string	ノードに設定された計算ユニット (CU) の消費量。	0.25
Runtime	object	インスタンスのランタイム時間フォーマット。
ProcessId	string	一意の実行 ID。	T3_123
Gateway	string	インスタンスが実行されるマシン。	cn-shanghai.1.2
DataSource	object	インスタンスに関連付けられたデータソースフォーマット。
Name	string	データソースの名前。	mysql_test
Status	string	インスタンスの実行ステータス。有効な値: NotRun: 未実行。 Running: 実行中。 WaitTime: TriggerTime の到着を待機中。 CheckingCondition: ブランチ条件を確認中。 WaitResource: リソースを待機中。 Failure: 実行が失敗した。 Success: 実行成功。 Checking: 品質ルールチェックのために送信済み。 WaitTrigger: 外部トリガーを待機中。トリガーベースのノードは、待機期間後にこのステータスになります。	Success
TriggerTime	integer	スケジュールされたトリガー時間。値は `1710239005403` のような 13 桁の数値です。	1710239005403
Bizdate	integer	ビジネス日。値は `1710239005403` のような 13 桁の数値です。	1710239005403
StartedTime	integer	インスタンスが実行を開始した時間。値は `1710239005403` のような 13 桁の数値です。	1710239005403
FinishedTime	integer	インスタンスが実行を終了した時間。値は `1710239005403` のような 13 桁の数値です。	1710239005403
Id	integer	タスクインスタンスの一意の識別子。	1234
ProjectId	integer	プロジェクトの ID。	100
ProjectEnv	string	プロジェクト環境。有効な値: Prod: 本番環境。 Dev: 開発環境。	Prod
Owner	string	ノードオーナーのアカウント ID。	1000
CreateTime	integer	作成時間。値は `1710239005403` のような 13 桁の数値です。	1710239005403
ModifyTime	integer	変更時間。値は `1710239005403` のような 13 桁の数値です。	1710239005403
CreateUser	string	インスタンスを作成したユーザーのアカウント ID。	1000
ModifyUser	string	インスタンスを最後に変更したユーザーのアカウント ID。	1000
ScriptParameters	string	スクリプトパラメーターのリスト。	para1=val1 para2=val2
WaitingResourceTime	integer	インスタンスがリソース待機状態になった時間。	1710239005403
WaitingTriggerTime	integer	インスタンスがスケジュール時刻待機状態になった時間。値は `1710239005403` のような 13 桁の数値です。	1710239005403
OperationType	string	インスタンスに対する最新操作のタイプ。	TriggerDqc
TotalCount	integer	Record の総数。	100
PageSize	integer	ページサイズ。	10
PageNumber	integer	ページ番号。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "SQL node\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "WorkflowName": "Test workflow\n",
        "TriggerType": "Scheduler\n",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "UnifiedWorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25\n"
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2\n"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Status": "Success",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "ScriptParameters": "para1=val1 para2=val2",
        "WaitingResourceTime": 1710239005403,
        "WaitingTriggerTime": 1710239005403,
        "OperationType": "TriggerDqc"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

エラーコード

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

変更履歴

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