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

指定されたインスタンスの下流インスタンスのページネーションリストを取得します。

操作説明

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:*

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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	ページネーション情報。
TaskInstances	array<object>	[非推奨] タスクインスタンスのリスト。このフィールドは非推奨です。代わりに DownstreamTaskInstances を使用してください。
	array<object>
StepType	string	スケジューリング依存関係の種類。有効な値： Normal：同一サイクル内でのスケジューリング依存関係 CrossCycle：跨サイクル（クロスサイクル）スケジューリング依存関係	Normal
TaskId	integer	このインスタンスが生成されるタスクの ID。	1234
TaskType	string	このインスタンスが生成されるタスクの種類。	ODPS_SQL
TaskName	string	このインスタンスが生成されるタスクの名前。	SQL node
Description	string	説明文。	test
WorkflowId	integer	このインスタンスが属するワークフローの ID。	1234
WorkflowName	string	このインスタンスが属するワークフローの名前。	Test workflow
TriggerType	string	インスタンスのスケジューリングをトリガーする方法。有効な値： Scheduler：スケジューリング周期に基づくトリガー Manual：手動トリガー列挙値: Scheduler : Manual :	Scheduler
TriggerRecurrence	string	トリガー後にインスタンスが実行されるモード。このパラメーターは TriggerType パラメーターが Scheduler に設定されている場合のみ有効です。有効な値： Pause Skip Normal 列挙値: Pause : Skip : Normal :	Normal
WorkflowInstanceId	integer	ワークフローインスタンス ID。	1234
WorkflowInstanceType	string	ワークフローインスタンスの種類。有効な値： SmokeTest SupplementData Manual ManualWorkflow Normal ManualFlow 列挙値: SmokeTest : SupplementData : Manual : ManualWorkflow : Normal : ManualFlow :	Normal
Timeout	integer	タスク実行のタイムアウト期間。単位：秒。注：このパラメーターの値は、時間単位で切り上げられます。	3600
RerunMode	string	再実行モード。有効な値： AllDenied：成功・失敗を問わず、タスクの再実行は許可されません。 FailureAllowed：タスクが失敗した場合のみ、再実行が許可されます。 AllAllowed：成功・失敗を問わず、タスクの再実行が許可されます。列挙値: 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	タスク実行のために構成されたスケジューリング用リソースグループの ID。	S_res_group_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：インスタンスはスケジューリング時刻の到着を待っています。 CheckingCondition：インスタンスのブランチ条件を確認しています。 WaitResource：インスタンスはリソースの確保を待っています。 Failure：インスタンスの実行に失敗しました。 Success：インスタンスは正常に実行されました。 Checking：インスタンスのデータ品質を確認しています。 WaitTrigger：インスタンスは外部スケジューリングシステムによるトリガーを待っています。	Success
TriggerTime	integer	スケジューリング時刻。	1710239005403
Bizdate	integer	データタイムスタンプ。	1710239005403
StartedTime	integer	インスタンスの実行開始時刻。	1710239005403
FinishedTime	integer	インスタンスの実行終了時刻。	1710239005403
Id	integer	インスタンス ID。	1234
ProjectId	integer	ワークスペース ID。	100
ProjectEnv `deprecated`	string	ワークスペースの環境。このパラメーターは非推奨であり、EnvType パラメーターに置き換えられています。有効な値：	Prod
EnvType	string	データソースが使用される環境。有効な値： Dev Prod	Prod
Owner	string	タスク所有者のアカウント ID。	100
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	更新時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	更新者のアカウント ID。	1000
DownstreamTaskInstances	array<object>	下流タスクインスタンスのリスト。
	array<object>
DependencyType	string	スケジューリング依存関係の種類。有効な値： Normal CrossCycle	Normal
TaskInstance	object	タスクインスタンスに関する情報。
TaskId	integer	このインスタンスが生成されるタスクの ID。	1234
TaskType	string	このインスタンスが生成されるタスクの種類。	ODPS_SQL
TaskName	string	このインスタンスが生成されるタスクの名前。	SQL node
Description	string	説明文。	test
WorkflowId	integer	このインスタンスが属するワークフローの ID。	1234
WorkflowName	string	このインスタンスが属するワークフローの名前。	Test workflow
TriggerType	string	トリガーの種類。有効な値： Scheduler：スケジューリング周期に基づくトリガー Manual：手動トリガー	Scheduler
TriggerRecurrence	string	トリガー後にインスタンスが実行されるモード。このパラメーターは TriggerType パラメーターが Scheduler に設定されている場合のみ有効です。有効な値： Pause Skip Normal	Normal
WorkflowInstanceId	integer	ワークフローインスタンス ID。	1234
WorkflowInstanceType	string	ワークフローインスタンスの種類。有効な値： Normal Manual SmokeTest SupplementData ManualWorkflow	Normal
Timeout	integer	タスク実行のタイムアウト期間。単位：秒。注：このパラメーターの値は、時間単位で切り上げられます。	3600
RerunMode	string	再実行モード。	AllAllowed
RunNumber	integer	インスタンスの実行回数。デフォルトでは 1 から開始します。	1
PeriodNumber	integer	サイクルのシーケンス番号。このパラメーターは、当日におけるタスクインスタンスのサイクルを示します。	1
BaselineId	integer	ベースライン ID。	1234
Priority	integer	タスクの優先度。最小値：1。最大値：8。値が大きいほど優先度が高くなります。デフォルト値：1。	1
RuntimeResource	object	ランタイム環境の構成（例：リソースグループ情報など）。
ResourceGroupId	string	タスク実行のために構成されたスケジューリング用リソースグループの ID。	S_res_group_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：インスタンスはスケジューリング時刻の到着を待っています。 CheckingCondition：インスタンスのブランチ条件を確認しています。 WaitResource：インスタンスはリソースの確保を待っています。 Failure：インスタンスの実行に失敗しました。 Success：インスタンスは正常に実行されました。 Checking：インスタンスのデータ品質を確認しています。 WaitTrigger：インスタンスは外部スケジューリングシステムによるトリガーを待っています。	Success
TriggerTime	integer	スケジューリング時刻。	1710239005403
Bizdate	integer	データタイムスタンプ。	1710239005403
StartedTime	integer	インスタンスの実行開始時刻。	1710239005403
FinishedTime	integer	インスタンスの実行終了時刻。	1710239005403
Id	integer	インスタンス ID。	1234
ProjectId	integer	ワークスペース ID。	100
EnvType	string	データソースが使用される環境。有効な値： Dev Prod	Prod
Owner	string	タスク所有者のアカウント ID。	1000
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	更新時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	更新者のアカウント ID。	1000
TotalCount	integer	レコードの総数。	100
PageSize	integer	ページサイズ。	10
PageNumber	integer	ページ番号。	1

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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