ListTasks API でページネーションされたタスクリストを取得 - DataWorks - Alibaba Cloud - DataWorks

ページごとにタスクのリストをクエリします。フィルター条件を指定してタスクをクエリすることもできます。

操作説明

DataWorks Basic Edition 以上が必要です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectEnv	string	任意	ワークスペースの環境。有効な値： Prod Dev 列挙値: Prod : Dev :	Prod
ProjectId	integer	必須	ワークスペース ID。	100
Name	string	任意	タスクの名前。あいまい一致をサポートしています。	SQL node
Ids	array	任意	タスクの ID。
	integer	任意	タスクのオーナーのアカウント ID。	1234
Owner	string	任意	タスクオーナーのアカウント ID。	1000
TaskType	string	任意	タスクのタイプ。有効な値は次のとおりです。 ODPS_SQL SPARK PY_ODPS PY_ODPS3 ODPS_SCRIPT ODPS_MR COMPONENT_SQL EMR_HIVE EMR_MR EMR_SPARK_SQL EMR_SPARK EMR_SHELL EMR_PRESTO EMR_IMPALA SPARK_STREAMING EMR_KYUUBI EMR_TRINO HOLOGRES_SQL HOLOGRES_SYNC_DDL HOLOGRES_SYNC_DATA	ODPS_SQL
RuntimeResource	string	任意	リソースグループに関する情報です。このパラメーターには、スケジューリング用のリソースグループの ID を設定します。	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	integer	任意	タスクが属するワークフローの ID。	1234
TriggerType	string	任意	トリガータイプ。有効な値は次のとおりです。 Scheduler：スケジュールによってトリガーされます。 Manual：手動でトリガーされます。列挙値: Scheduler : Manual :	Scheduler
TriggerRecurrence	string	任意	トリガーされたときの実行モード。`TriggerType` が `Scheduler` の場合にのみ有効です。有効な値は次のとおりです。 Pause Skip Normal 列挙値: Pause : Skip : Normal :	Normal
SortBy	string	任意	タスクのソートに使用されるフィールドです。このパラメーターは、「ソートフィールドソート順」の形式で設定します。ソート順は `Desc` または `Asc` に設定できます。ソート順を指定しない場合、デフォルトで `Asc` が使用されます。有効な値は次のとおりです。 `ModifyTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` デフォルト値：`Id Desc`。	Id Desc
PageSize	integer	任意	ページあたりのエントリ数。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1

レスポンスフィールド

フィールド	型	説明	例
	object	ResultModel
RequestId	string	リクエスト ID。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	ページネーション情報。
TotalCount	integer	返されたエントリの総数。	100
PageSize	integer	ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
Tasks	array<object>	タスク。
	array<object>
Name	string	タスクの名前。	SQL node
Description	string	タスクの説明。	test
WorkflowId	integer	タスクが属するワークフローの ID。	1234
InstanceMode	string	インスタンス生成モード。有効な値は次のとおりです。 T+1 Immediately	T+1
Type	string	タスクのタイプ。	ODPS_SQL
BaselineId	integer	ベースライン ID。	1234
Priority	integer	タスクの優先度。有効な値：1～8。値が大きいほど優先度が高くなります。デフォルト値：1。	1
Timeout	integer	タスク実行のタイムアウト期間。単位：秒。	3600
RerunMode	string	再実行モード。有効な値は次のとおりです。 AllDenied：タスクが正常に実行されたか、実行に失敗したかに関係なく、タスクを再実行できません。 FailureAllowed：タスクの実行に失敗した場合にのみ、タスクを再実行できます。 AllAllowed：タスクが正常に実行されたか、実行に失敗したかに関係なく、タスクを再実行できます。列挙値: AllDenied : FailureAllowed : AllAllowed :	AllAllowed
RerunTimes	integer	タスクが再実行される回数。このパラメーターは、`RerunMode` パラメーターが `AllAllowed` または `FailureAllowed` に設定されている場合にのみ有効です。	3
RerunInterval	integer	再実行間隔。単位：秒。	60
Trigger	object	タスクスケジューリングをトリガーするメソッド。
Type	string	トリガータイプ。有効な値は次のとおりです。 Scheduler：スケジューリングサイクルベースのトリガー Manual：手動トリガー列挙値: Scheduler : Manual :	Scheduler
Recurrence	string	トリガー後のタスクの実行モード。このパラメーターは、`Type` パラメーターが `Scheduler` に設定されている場合にのみ有効です。有効な値は次のとおりです。 Pause Skip Normal 列挙値: Pause : Skip : Normal :	Normal
Cron	string	タスクの CRON 式。このパラメーターは、`Type` パラメーターが `Scheduler` に設定されている場合にのみ有効です。	00 00 00 * * ?
StartTime	string	タスクが定期的にスケジューリングされる時間範囲の開始時刻。このパラメーターは、`Type` パラメーターが `Scheduler` に設定されている場合にのみ有効です。	1970-01-01 00:00:00
EndTime	string	タスクが定期的にスケジューリングされる時間範囲の終了時刻。このパラメーターは、`Type` パラメーターが `Scheduler` に設定されている場合にのみ有効です。	9999-01-01 00:00:00
RuntimeResource	object	リソースグループ情報など、実行環境の構成です。
ResourceGroupId	string	タスク実行用に構成された、スケジューリング用リソースグループの ID です。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	タスク実行用に構成されたイメージの ID。	i-xxxxxx
Cu	string	タスク実行用に構成されたデフォルトの計算ユニット (CU) 数。	0.25
DataSource	object	関連付けられたデータソースに関する情報です。
Name	string	データソースの名前。	mysql_test
Id	integer	タスク ID。	1234
ProjectId	integer	ワークスペース ID。	100
ProjectEnv	string	ワークスペースの環境。有効な値は次のとおりです。 Prod：本番環境 Dev：開発環境列挙値: Prod : Dev :	Prod
Owner	string	タスクオーナーのアカウント ID。	1000
CreateTime	integer	作成時間。	1710239005403
ModifyTime	integer	変更時間。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	変更者のアカウント ID。	1000
ScriptParameters	string	スクリプトパラメーターのリスト。	para1=$bizdate para2=$[yyyymmdd]

例

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "Tasks": [
      {
        "Name": "SQL node\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "InstanceMode": "T+1",
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "Trigger": {
          "Type": "Scheduler\n",
          "Recurrence": "Normal\n",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00\n",
          "EndTime": "9999-01-01 00:00:00\n"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "ScriptParameters": "para1=$bizdate para2=$[yyyymmdd] "
      }
    ]
  }
}

エラーコード

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

変更履歴

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