GetTaskInstance 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	必須	タスクインスタンスの一意な識別子。	1234

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。ログの特定および問題のトラブルシューティングに使用されます。	22C97E95-F023-56B5-8852-B1A77****
TaskInstance	object	タスクインスタンスの詳細情報。
TaskId	integer	対応するタスクの ID。	1234
TaskType	string	対応するタスクのタイプ。	ODPS_SQL
TaskName	string	対応するタスクの名前。	SQL ノード
Description	string	スクリプトの説明。	テスト
WorkflowId	integer	タスクインスタンスが属するワークフローの ID。	1234
WorkflowName	string	タスクインスタンスが属するワークフローの名前。	テストワークフロー
TriggerType	string	トリガータイプ。トリガータイプは、GetTask 操作の Trigger.Type レスポンスパラメーターから取得できます。有効な値: Scheduler: スケジューリング周期によってトリガーされます。 Manual: 手動でトリガーされます。	Scheduler
TriggerRecurrence	string	トリガーされるときの実行中のモード。このパラメーターは、TriggerType が Scheduler にセットされている場合に効果を発揮します。有効な値: Normal: 定期的にスケジュールされる法線の定期タスク。 Manual: 定期的にスケジュールされない手動タスク。 Pause: 定期的にスケジュールされるが、スケジューリング開始時間に失敗した状態にセットされる一時停止タスク。 Skip: 定期的にスケジュールされるが、スケジューリング開始時間に成功にセットされるドライランタスク。 SkipUnchoose: 一時的なワークフローで選択されていないタスク。この値は一時的なワークフローにのみ存在します。タスクはスケジューリング開始時間に成功にセットされます。 SkipCycle: 実行中の周期が到来していない週次または月次タスク。タスクは定期的にスケジュールされますが、スケジューリング開始時間に成功にセットされます。 ConditionUnchoose: 上流のブランチ (IF) ノードによって選択されていない下流ノード。タスクは直接ドライランになります。 RealtimeDeprecated: リアルタイムで生成された期限切れの定期インスタンス。タスクは成功にセットされます。 PauseCalendar: カレンダーが参照されているため、インスタンスが一時停止されています。 SkipCalendar: カレンダーが参照されているため、インスタンスがドライランになっています。	法線
WorkflowInstanceId	integer	タスクインスタンスが属するワークフローインスタンスの ID。	1234
WorkflowInstanceType	string	タスクインスタンスが属するワークフローインスタンスのタイプ。有効な値: SmokeTest: テスト。 SupplementData: データバックフィル。 Manual: 手動タスク。 ManualWorkflow: 手動ワークフロー。 Normal: 法線期間スケジューリング。 ManualFlow: 手動で実行されるビジネスフロー。	法線
UnifiedWorkflowInstanceId	integer	統合ワークフローインスタンス ID。単一のトリガー下の同じビジネス日付内のすべてのタスクインスタンスは、このフィールドに対して同じ値を共有します。	1234
Timeout	integer	タスク実行のタイムアウト期間。単位: 秒。注: スケジューリングシステムは、設定された値を最も近い時間に丸めます。	3600
RerunMode	string	タスクの再実行構成。有効な値: AllDenied: タスクの成否にかかわらず、再実行は許可されません。 AllAllowed: タスクの成否にかかわらず、再実行が許可されます。 FailureAllowed: タスクが失敗した場合にのみ、再実行が許可されます。	AllAllowed
RunNumber	integer	現在の実行番号。デフォルトでは、値は 1 から始まります。	1
PeriodNumber	integer	周期番号。タスクインスタンスがその日のどのスケジューリング周期にあるかを示します。	1
BaselineId	integer	ベースライン ID。	1234
Priority	integer	タスクの実行中の優先度。最小値: 1。最大値: 8。値が大きいほど優先度が高くなります。デフォルト値: 1。	1
Script	object	実行中のスクリプト情報。
Content	string	スクリプトのコンテンツ。	echo "helloWorld"
Parameters	string	スクリプトパラメーターのリスト。	para1=$bizdate
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
Inputs	object	入力情報。
Variables	array<object>	変数定義のリスト。
	object	変数定義のリスト。
Name	string	変数の名前。	Key1
Type	string	タイプ。有効な値: Constant: 定数。 PassThrough: パラメーターノードの出力。 System: 変数。 NodeOutput: スクリプトの出力。	Constant
Value	string	変数の値。	Value1
Outputs	object	出力情報。
TaskOutputs	array<object>	タスク出力定義のリスト。
	object	タスク出力定義のリスト。
Output	string	出力識別子。	pre.odps_sql_demo_0
Variables	array<object>	変数定義のリスト。
	object	変数定義のリスト。
Name	string	変数の名前。	key1
Type	string	タイプ。有効な値: Constant: 定数。 PassThrough: パラメーターノードの出力。 System: 変数。 NodeOutput: スクリプトの出力。	Constant
Value	string	変数の値。	値1
Tags	array<object>	ノードタグのリスト。
	object	ノードタグのリスト。
Key	string	ラベルキー。	key1
Value	string	ラベル値。	値1
Status	string	インスタンスの実行ステータス。有効な値: NotRun: 未実行。 Running: 実行中。 WaitTime: TriggerTime の到来を待機中。 CheckingCondition: ブランチ条件の確認中。 WaitResource: リソースの待機中。 Failure: 実行失敗。 Success: 実行成功。 Checking: Data Quality チェック用に送信済み。 WaitTrigger: 外部トリガーの待機中。トリガーベースのノードは、待機時間の経過後にこのステータスになります。	Success
TriggerTime	integer	スケジュールされたトリガー時刻。	1710239005403
Bizdate	integer	業務日付。	1710239005403
StartedTime	integer	実行の開始時刻。	1710239005403
FinishedTime	integer	完了時刻。	1710239005403
Id	integer	ノードインスタンスの一意な識別子。	1234
ProjectId	integer	プロジェクト ID。	100
ProjectEnv	string	プロジェクト環境。有効な値: Prod: 本番環境。 Dev: 開発環境。	Prod
Owner	string	ノードオーナーのアカウント ID。	1000
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	変更時刻。	1710239005403
CreateUser	string	インスタンスを作成したユーザーのアカウント ID。	1000
ModifyUser	string	インスタンスを変更したユーザーのアカウント ID。	1000
WaitingResourceTime	integer	インスタンスがリソース待機状態になった時刻。	1710239005403
WaitingTriggerTime	integer	インスタンスがスケジュール時刻待機状態になった時刻。	1710239005403
OperationType	string	インスタンスに対する最新操作のタイプ。	TriggerDqc

例

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL ノード",
    "Description": "テスト",
    "WorkflowId": 1234,
    "WorkflowName": "テストワークフロー",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "法線",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "法線",
    "UnifiedWorkflowInstanceId": 1234,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_グループ_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "Runtime": {
      "ProcessId": "T3_123",
      "Gateway": "cn-shanghai.1.2"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "値1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "値1"
      }
    ],
    "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",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403,
    "OperationType": "TriggerDqc"
  }
}

エラーコード

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

変更履歴

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