GetSemanticJobDetail - DataWorks - Alibaba Cloud ドキュメントセンター

RunSemanticJob または ListSemanticJobRuns が返す ExecutorJobId を使用して、エグゼキュータのステータスとランタイム構成を照会します。

操作説明

シナリオ

エグゼキュータ側におけるセマンティックジョブ実行の詳細なステータスとランタイム情報を照会します。これは、実行進捗のポーリングや実行失敗のトラブルシューティングに使用されます。

手順

RunSemanticJob または ListSemanticJobRuns を呼び出して ExecutorJobId を取得します。
タスク解像度で返された ProjectId を、この操作の ProjectId として使用します。
Data 内のエグゼキュータ詳細に基づいて現在のステータスを判断します。タスクがまだ実行中の場合は、この操作のポーリングを継続します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ExecutorJobId	string	必須	エグゼキュータタスク ID。RunSemanticJob の応答の Data.ExecutorJobId、または ListSemanticJobRuns の Record の ExecutorJobId を使用します。	exec-job-demo
ProjectId	integer	必須	タスクが属する DataWorks ワークスペースの ID。CreateSemanticJob の応答の ProjectId、または ListSemanticJobs のリスト項目を使用します。	100

各リクエストフィールドの説明に基づいてリクエストパラメーターを構築してください。

レスポンスフィールド

フィールド	型	説明	例
	object	エグゼキュータの実行詳細を照会するための標準的なクエリ応答です。Data には、指定された ExecutorJobId に対して現在返されているエグゼキュータの詳細が含まれます。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	リクエストが成功したかどうかを示します。
Data	object	エグゼキュータによって返されるタスクの詳細。実行ステータスの判断や実際のランタイム構成のビューに使用されます。
ExecutorJobId	string	エグゼキュータジョブ ID。	exec-job-demo
FileType	integer	エグゼキュータのノードタイプコード。セマンティックジョブではシェルノードコード 6 を使用します。	6
ProjectId	integer	エグゼキュータジョブに関連付けられた DataWorks ワークスペース ID。	100
Datasource	string	エグゼキュータジョブで使用されるデータソース識別子。	maxcompute
CodeParameters	string	エグゼキュータによって返されるコードパラメーター情報。今回の実行のランタイム構成のトラブルシューティングに使用されます。	--limit 100
Env	string	エグゼキュータによって返される実行環境識別子。	PROD
CustomerName	string	エグゼキュータジョブの顧客識別子。	meta_semantic
CurrentSqlIndex	integer	エグゼキュータが現在処理している SQL フラグメントのインデックス。	0
ExecTypes	array	エグゼキュータによって返される実行タイプコードのリスト。
	integer	エグゼキュータによって返される実行タイプコードのリスト。	6
Statuses	array	エグゼキュータによって返されるステータスコードのリスト。ジョブの現在または最終ステータスを判断するために使用されます。
	integer	エグゼキュータによって返されるジョブステータスコードのリスト。成功ステータスには 3 が含まれます。	3
AdvanceSettings	object	エグゼキュータによって返される高度なランタイム設定。
ResourceUrls	array<object>	エグゼキュータジョブに関連付けられたリソース URL のリスト。
	object	エグゼキュータによって返されるリソース URL のリスト。
ResourceGroupId	string	実際にジョブを実行したリソースグループの ID。	rg-demo

応答フィールドの意味および後続の呼び出しとの関係については、各フィールドの説明を参照してください。

例

成功レスポンス

JSONJSON

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "ExecutorJobId": "exec-job-demo",
    "FileType": 6,
    "ProjectId": 100,
    "Datasource": "maxcompute",
    "CodeParameters": "--limit 100",
    "Env": "PROD",
    "CustomerName": "meta_semantic",
    "CurrentSqlIndex": 0,
    "ExecTypes": [
      6
    ],
    "Statuses": [
      3
    ],
    "AdvanceSettings": {
      "test": "test",
      "test2": 1
    },
    "ResourceUrls": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "ResourceGroupId": "rg-demo"
  }
}

エラーコード

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

変更履歴

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

DataWorks:GetSemanticJobDetail