GetTask API の概要 - DataWorks

タスクの情報を照会します。

今すぐお試しください

この 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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	必須	タスク ID。	1234
ProjectEnv	string	任意	ワークスペースの環境。有効な値: Prod: 本番環境 Dev: 開発環境	Prod

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	22C97E95-F023-56B5-8852-B1A77A17XXXX
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。	1
Timeout	integer	タスク実行のタイムアウト期間。単位: 秒。	3600
RerunMode	string	再実行モード。有効な値: AllDenied: タスクが正常に実行されたか、実行に失敗したかにかかわらず、タスクを再実行することはできません。 FailureAllowed: タスクは、実行に失敗した場合にのみ再実行できます。 AllAllowed: タスクが正常に実行されたか、実行に失敗したかにかかわらず、タスクを再実行できます。	AllAllowed
RerunTimes	integer	タスクが再実行される回数。このパラメーターは、RerunMode パラメーターが AllAllowed または FailureAllowed に設定されている場合にのみ有効です。	3
RerunInterval	integer	再実行間隔。単位: 秒。	60
Script	object	スクリプト情報。
Content	string	スクリプトの内容。	echo "helloWorld"
Parameters	string	スクリプトパラメーター。	para1=$bizdate
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
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
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	変数の値。	value1
Dependencies	array<object>	依存関係情報。
	object
Type	string	依存関係タイプ。有効な値: CrossCycleDependsOnChildren: レベル 1 の子孫ノードに対するクロスサイクル依存関係 CrossCycleDependsOnSelf: 現在のノードに対するクロスサイクル依存関係 CrossCycleDependsOnOtherNode: 他のノードに対するクロスサイクル依存関係 Normal: 同サイクルスケジューリング依存関係	Normal
UpstreamOutput	string	祖先タスクの出力の識別子。このパラメーターは、`同サイクルスケジューリング依存関係`とノード入力が構成されている場合にのみ返されます。	pre.odps_sql_demo_0
UpstreamTaskId	string	祖先タスク ID。このパラメーターは、`クロスサイクルスケジューリング依存関係`または`同サイクルスケジューリング依存関係`とノード入力が構成されていない場合にのみ返されます。	1234
SubTasks	object	do-while ノードなど、サブタスクの構成。
SubTasks	array<object>	サブタスク。
	array<object>
Name	string	タスク名。	SQL node
Description	string	タスクの説明。	test
WorkflowId	integer	タスクが属するワークフローの ID。	1234
Type	string	タスクのタイプ。	ODPS_SQL
BaselineId	integer	ベースライン ID。	The baseline ID.
Priority	integer	タスクの優先度。有効な値: 1 から 8。値が大きいほど優先度が高くなります。デフォルト値: 1。	1
Timeout	integer	タスク実行のタイムアウト期間。単位: 秒。	3600
RerunMode	string	再実行モード。有効な値: AllDenied: タスクが正常に実行されたか、実行に失敗したかにかかわらず、タスクを再実行することはできません。 FailureAllowed: タスクは、実行に失敗した場合にのみ再実行できます。 AllAllowed: タスクが正常に実行されたか、実行に失敗したかにかかわらず、タスクを再実行できます。	AllAllowed
RerunTimes	integer	タスクが再実行される回数。このパラメーターは、RerunMode パラメーターが AllAllowed または FailureAllowed に設定されている場合にのみ有効です。	3
RerunInterval	integer	再実行間隔。単位: 秒。	180
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
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
EnvType	string	ワークスペースの環境。有効な値: Prod: 本番環境 Dev: 開発環境	Prod
Owner	string	タスクオーナーのアカウント ID。	1000
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	変更時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	変更者のアカウント ID。	1000
Type	string	サブタスクのタイプ。有効な値: DoWhile: do-while ノード Combined: ノードグループ ForEach: for-each ノード	Combined
Tags	array<object>	タグ。
	object
Key	string	タグキー。	key1
Value	string	タグ値。	value1
Id	integer	インスタンス ID。	1234
ProjectId	integer	ワークスペース ID。	100
ProjectEnv `deprecated`	string	ワークスペースの環境。このパラメーターは非推奨であり、EnvType パラメーターに置き換えられます。有効な値: Prod: 本番環境 Dev: 開発環境	Prod
EnvType	string	ワークスペースの環境。有効な値: Prod: 本番環境 Dev: 開発環境	Prod
Owner	string	タスクオーナーのアカウント ID。	1000
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	変更時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	変更者のアカウント ID。	1000

例

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Task": {
    "Name": "SQL node",
    "Description": "test",
    "WorkflowId": 1234,
    "InstanceMode": "T+1",
    "Type": "ODPS_SQL",
    "BaselineId": 1234,
    "Priority": 1,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RerunTimes": 3,
    "RerunInterval": 60,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "9999-01-01 00:00:00"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx\n",
      "Cu": "0.25"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant\n",
          "Value": "Value1\n"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant\n",
          "Value": "value1"
        }
      ]
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": "1234"
      }
    ],
    "SubTasks": {
      "SubTasks": [
        {
          "Name": "SQL node\n",
          "Description": "test",
          "WorkflowId": 1234,
          "Type": "ODPS_SQL\n",
          "BaselineId": 0,
          "Priority": 1,
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RerunTimes": 3,
          "RerunInterval": 180,
          "Trigger": {
            "Type": "Scheduler",
            "Recurrence": "Normal\n",
            "Cron": "00 00 00 * * ?\n",
            "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",
            "Cu": "0.25"
          },
          "DataSource": {
            "Name": "mysql_test\n"
          },
          "Id": 1234,
          "ProjectId": 100,
          "ProjectEnv": "Prod",
          "EnvType": "Prod",
          "Owner": "1000\n",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000\n",
          "ModifyUser": "1000\n"
        }
      ],
      "Type": "Combined"
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000\n",
    "ModifyUser": "1000"
  }
}

エラーコード

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

変更履歴

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