使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 停止指定執行。呼叫成功僅表示停止請求已受理,最終狀態請透過 GetSemanticJobDetail 查詢。
介面說明
使用場景
向執行器發起停止指定語意任務執行的請求,適用於任務長時間執行、需要人工中止或資源回收的場景。
呼叫流程
從
RunSemanticJob或ListSemanticJobRuns獲取ExecutorJobId,並使用任務的ProjectId。可按需傳入
RetryTimes。呼叫後使用
GetSemanticJobDetail輪詢最終狀態,必要時讀取GetSemanticJobLog診斷。
注意事項
介面成功僅表示停止請求已被處理,不等同於任務已經進入終態。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dataworks:KillSemanticJob |
update |
*全部資源。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ExecutorJobId |
string |
是 |
待停止執行的執行器任務識別碼,使用 RunSemanticJob 回應的 Data.ExecutorJobId 或 ListSemanticJobRuns 記錄中的 ExecutorJobId。 |
exec-job-demo |
| ProjectId |
integer |
是 |
待停止任務所屬的 DataWorks 工作空間 ID,使用 CreateSemanticJob 回應或 ListSemanticJobs 清單項目的 ProjectId。 |
100 |
| RetryTimes |
integer |
否 |
向執行器發起停止請求時使用的重試次數。通常可省略;傳入時使用非負整數,並在呼叫後透過 GetSemanticJobDetail 確認最終狀態。 |
1 |
請根據各請求欄位的說明建構呼叫參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
停止執行請求的標準回應。Data 僅表示請求處理結果,不表示任務已經進入終態。 |
||
| RequestId |
string |
請求 ID。用於定位日誌和排查問題。 |
676271D6-53B4-57BE-89FA-72F7AE1418DF |
| Success |
boolean |
請求是否成功。 |
|
| Data |
boolean |
停止請求是否已被執行器受理;返回 true 後仍應使用 GetSemanticJobDetail 查詢最終狀態。 |
回應欄位含義和後續呼叫關係請參閱各欄位說明。
樣本
正常返回樣本
JSON格式
{
"RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
"Success": false,
"Data": false
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。