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

名前を指定して保存済みのセマンティックタスクを実行用に送信し、実行 ID およびエグゼキュータ識別子を返します。呼び出しが成功したことはタスクが送信されたことを示しており、意味理解モデルの結果が生成されたことを示すものではありません。

操作説明

説明

Name を使用して保存済みのセマンティックタスクの定義を読み込み、新しい分析実行をエグゼキュータに送信します。この操作では、Source、リソースグループ、またはリファレンスファイルのランタイムオーバーライドは受け付けられません。実行時には常に CreateSemanticJob で保存された構成が使用されます。

実行前の検証

サービスはタスクの存在とアクセス権限を検証し、関連付けられたファイルがまだ存在するかどうかを再検証します。ReferenceFileIds を通じて関連付けられたファイルについては、送信前に現在の実行で読み取り可能な一時アドレスに解決されます。アップロード後にファイルが削除された場合、または無効なファイル ID が指定された場合、送信は失敗します。

応答と次のステップ

Data.JobRunId は現在のセマンティックタスク実行の ID であり、DownloadSemanticResults でこの実行の正確な出力をダウンロードするために使用されます。Data.ExecutorJobId はエグゼキュータタスクの ID であり、GetSemanticJobDetail、GetSemanticJobLog、および KillSemanticJob で使用されます。応答が成功したことは、エージェントが送信を受け入れたことを示しており、モデル分析や結果ファイルが完了したことを示すものではありません。

課金

この操作を使用する前に、セマンティック構築で使用されるモデル呼び出しの課金方法と料金を完全に理解していることを確認してください。

今すぐお試しください

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

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	実行するタスクの名前。CreateSemanticJob の応答の Data.Name 値、または ListSemanticJobs のリスト項目の Name 値を使用します。タスクの Source、ResourceGroupId、およびリファレンスファイルは、作成時に保存された定義によって決定されます。	semantic-job-demo

各リクエストフィールドの説明に基づいて呼び出しパラメーターを構築します。

レスポンスフィールド

フィールド	型	説明	例
	object	セマンティックタスク実行を送信するための標準的な応答です。Data 内の 2 つの識別子は、それぞれ結果のダウンロードとエグゼキュータのクエリに使用されます。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	リクエストが成功したかどうかを示します。
Data	object	この送信の実行情報。送信が成功したことは、意味理解モデルの出力が生成されたことを示すものではありません。結果をダウンロードする前に、詳細取得操作を使用してステータスを確認してください。
JobRunId	string	この実行の一意の識別子。この値を DownloadSemanticResults の JobRunId パラメーターに渡して、この実行の出力を取得します。	01H00000000000000000000000
ExecutorJobId	string	エグゼキュータタスクの識別子。この値を GetSemanticJobDetail、GetSemanticJobLog、または KillSemanticJob の ExecutorJobId パラメーターに渡します。	exec-job-demo
CurrentSqlIndex	integer	送信応答でエグゼキュータから返される現在の SQL フラグメントインデックス。	0
ExecTypes	array	送信応答でエグゼキュータから返される実行タイプコードのリスト。
	integer	エグゼキュータから返される実行タイプコードのリスト。	6
Env	string	サブミット応答でエグゼキュータによって返される実行環境識別子。	PROD
Statuses	array	送信応答でエグゼキュータから返されるステータスコードのリスト。送信段階でのステータスは、結果が完了していることを示すものではありません。
	integer	エグゼキュータから返されるタスクステータスコードのリスト。成功ステータスには 3 が含まれます。	3

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

例

成功レスポンス

JSONJSON

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "JobRunId": "01H00000000000000000000000",
    "ExecutorJobId": "exec-job-demo",
    "CurrentSqlIndex": 0,
    "ExecTypes": [
      6
    ],
    "Env": "PROD",
    "Statuses": [
      3
    ]
  }
}

エラーコード

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

変更履歴

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