ListUpstreamTasks API の概要 - DataWorks - Alibaba Cloud - DataWorks

タスクの祖先タスクの一覧をページ単位で照会します。

操作説明

この API オペレーションは、DataWorks のすべてのエディションで利用可能です。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectEnv	string	任意	ワークスペースの環境。有効な値： Prod：本番環境 Dev：開発環境	Prod
Id	integer	必須	タスク ID。	1234
PageSize	integer	任意	1 ページあたりの件数。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号。先頭ページは 1 から始まります。デフォルト値：1。	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	ページネーション情報。
Tasks	array<object>	タスク。このパラメーターは非推奨であり、代わりに UpstreamTasks パラメーターを使用してください。
	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
Timezone	string	タイムゾーン。	Asia/Shanghai
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 `deprecated`	string	ワークスペースの環境。このパラメーターは非推奨であり、EnvType パラメーターに置き換えられています。有効な値： Prod Dev 列挙値: Prod : Dev :	Prod
EnvType	string	ワークスペースの環境。有効な値： Prod Dev	Prod
Owner	string	タスク所有者のアカウント ID。	1000
StepType	string	スケジューリング依存関係の種類。有効な値： Normal：同一サイクルのスケジューリング依存関係 CrossCycle：クロスサイクルのスケジューリング依存関係	Normal
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	更新時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	更新者のアカウント ID。	1000
UpstreamTasks	array<object>	祖先タスク。
	array<object>
DependencyType	string	スケジューリング依存関係の種類。有効な値： Normal：同一サイクルのスケジューリング依存関係 CrossCycle：クロスサイクルのスケジューリング依存関係	Normal
Task	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
Timeout	integer	タスク実行のタイムアウト期間（単位：秒）。	3600
RerunMode	string	再実行モード。有効な値： AllDenied：タスクが正常終了した場合でも失敗した場合でも、再実行できません。 FailureAllowed：タスクが失敗した場合のみ再実行できます。 AllAllowed：タスクが正常終了した場合でも失敗した場合でも、再実行できます。	AllAllowed
RerunTimes	integer	タスクの再実行回数。このパラメーターは、RerunMode パラメーターが AllAllowed または FailureAllowed に設定されている場合にのみ有効です。	3
RerunInterval	integer	再実行間隔（単位：秒）。	60
Trigger	object	トリガー方法。
Type	string	トリガーの種類。有効な値： Scheduler：スケジュール周期に基づくトリガー Manual：手動トリガー	Scheduler
Recurrence	string	トリガー後にタスクが実行されるモード。このパラメーターは、Type パラメーターが Scheduler に設定されている場合にのみ有効です。有効な値： 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
Timezone	string	タイムゾーン。	Asia/Shanghai
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
EnvType	string	ワークスペースの環境。有効な値： Prod Dev	Prod
Owner	string	タスク所有者のアカウント ID。	1000
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	更新時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	更新者のアカウント ID。	1000
TotalCount	integer	返却される合計件数。	100
PageSize	integer	1 ページあたりの件数。	10
PageNumber	integer	ページ番号。	1

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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