Call ListTaskFlowInstance to query task flow execution records - Data Management (DMS)

タスクフローの実行レコードをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListTaskFlowInstance

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DagId	integer	必須	タスクフローの ID。`ListTaskFlow` または `ListLhTaskFlowAndScenario` 操作を呼び出して、タスクフローの ID を取得できます。	7***
TriggerType	integer	任意	タスクフローがトリガーされるモード。有効な値： 0：タスクフローは定期的なスケジューリングに基づいて自動的にトリガーされます。 1：タスクフローは手動でトリガーされます。	1
StartTimeBegin	string	任意	タスクフローの実行レコードをクエリする期間の開始時刻。時間は yyyy-MM-DD 形式で指定します。	2022-01-07
StartTimeEnd	string	任意	タスクフローの実行レコードをクエリする期間の終了時刻。時間は yyyy-MM-DD 形式で指定します。	2022-04-08
PageIndex	integer	必須	返すページ番号。	1
PageSize	integer	必須	各ページで返すエントリ数。	20
Tid	integer	任意	テナントの ID。`GetUserActiveTenant` または `ListUserTenants` 操作を呼び出して、テナント ID を取得できます。	3***
UseBizDate	boolean	任意	フィルター条件を調整します： true：`StartTimeBegin` と `StartTimeEnd` は、サービスをフィルタリングするための期間です。 false：`StartTimeBegin` と `StartTimeEnd` は、タスクを実行するための期間です。	true
Status	integer	任意	タスクノードの実行ステータス。有効な値： 0：スケジューリング待ち 1：実行中 2：一時停止 3：実行失敗 4：実行成功 5：完了	2

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	8CFF2295-8249-5287-B888-DBD4F0D76CB0
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	UnknownError
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージ。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功です。 false：リクエストは失敗です。	true
DAGInstanceList	object
DAGInstance	array<object>	返された実行レコードに関する情報。
	object
Id	integer	実行レコードの ID。	9234
BusinessTime	string	タスクフローの業務日時。時間は yyyy-MM-DD HH:mm:ss 形式で表示されます。	2021-11-10 14:37:26
startTime	string	タスクフローの実行が開始された時刻。時間は yyyy-MM-DD HH:mm:ss 形式で表示されます。	2021-11-11 14:35:57
EndTime	string	タスクフローの実行が完了した時刻。時間は yyyy-MM-DD HH:mm:ss 形式で表示されます。	2021-11-11 14:38:57
DagId	string	タスクフローの ID。	7***
TriggerType	integer	タスクフローがトリガーされるモード。有効な値： 0：タスクフローは定期的なスケジューリングに基づいて自動的にトリガーされます。 1：タスクフローは手動でトリガーされます。	1
Status	integer	タスクフローのステータス。有効な値： 0：タスクフローはスケジューリング待ちです。 1：タスクフローは実行中です。 2：タスクフローは一時停止中です。 3：タスクフローは失敗しました。 4：タスクフローは実行済みです。 5：タスクフローは完了です。	4
Message	string	タスクの説明。	test
HistoryDagId	integer	以前に公開されたバージョンのタスクフローの ID。	2****
DagName	string	タスクフローの名前。	Spark_SQL_test
OwnerName	string	タスクフローのオーナーの名前。	test_name
DagVersion	string	タスクフローのバージョン。	[]
TotalCount	integer	返された実行レコードの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "8CFF2295-8249-5287-B888-DBD4F0D76CB0",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "DAGInstanceList": {
    "DAGInstance": [
      {
        "Id": 9234,
        "BusinessTime": "2021-11-10 14:37:26",
        "startTime": "2021-11-11 14:35:57\n",
        "EndTime": "2021-11-11 14:38:57",
        "DagId": "7***",
        "TriggerType": 1,
        "Status": 4,
        "Message": "test",
        "HistoryDagId": 0,
        "DagName": "Spark_SQL_test",
        "OwnerName": "test_name",
        "DagVersion": "[]"
      }
    ]
  },
  "TotalCount": 1
}

エラーコード

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

変更履歴

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