RunSemanticJob - DataWorks

介面說明

功能說明

按 Name 載入一個已儲存的語意任務定義，並向執行器提交一次新的分析執行。本介面不接收執行階段的 Source、資源群組或參考檔案覆蓋項目：執行時始終使用 CreateSemanticJob 儲存的設定。

執行前驗證

服務會驗證任務存在性和存取權限，並重新驗證已關聯檔案是否仍存在。對於透過 ReferenceFileIds 關聯的檔案，服務會在提交前解析為本次執行可讀取的臨時位址；因此上傳後刪除檔案或填寫無效的檔案 ID 會導致提交失敗。

回應與後續操作

Data.JobRunId 識別本次語意任務執行，用於 DownloadSemanticResults 精確下載本次產出物；Data.ExecutorJobId 識別執行器任務，用於 GetSemanticJobDetail、GetSemanticJobLog 和 KillSemanticJob。回應成功表示執行器已接受提交，不表示模型分析或結果檔案已經完成。

費用說明

請確保在使用該介面前，已充分了解語意建構使用的模型呼叫的收費方式和價格。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:RunSemanticJob

create

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	是	待執行任務的名稱，使用 CreateSemanticJob 回應的 Data.Name 或 ListSemanticJobs 清單項目的 Name。任務的 Source、ResourceGroupId 和參考檔案由建立時儲存的定義決定。	semantic-job-demo

請根據各請求欄位的說明建構呼叫參數。

返回參數

名稱	類型	描述	樣本值
	object	提交語意任務執行的標準回應。Data 中的兩個識別碼分別用於結果下載和執行器查詢。
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

回應欄位含義和後續呼叫關係請參閱各欄位說明。

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。