按已建立任務的 Name 刪除任務定義。當任務正在執行時,請先使用該執行中的 ExecutorJobId 呼叫 KillSemanticJob 並確認停止。
介面說明
使用場景
歸檔刪除一個已儲存的語意任務定義,使其不再出現在可用任務清單中。
呼叫流程
從
CreateSemanticJob.Data.Name或ListSemanticJobs.Data.SemanticJobs[].Name取得任務名稱。如需確認是否存在未結束的執行個體,請先呼叫
ListSemanticJobRuns;必要時透過KillSemanticJob停止執行。呼叫本介面刪除任務定義。
結果說明
回應成功表示刪除請求已完成;後續無法再使用該名稱呼叫 RunSemanticJob。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Name |
string |
是 |
待刪除任務的名稱,請使用 CreateSemanticJob 回應中的 Data.Name 或 ListSemanticJobs 清單項目中的 Name。 |
semantic-job-demo |
請根據各請求欄位的說明建構呼叫參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
刪除語意任務的標準回應。Data 表示歸檔刪除結果。 |
||
| RequestId |
string |
請求 ID。用於定位日誌和排查問題。 |
676271D6-53B4-57BE-89FA-72F7AE1418DF |
| Success |
boolean |
請求是否成功。 |
|
| Data |
object |
任務刪除結果。刪除操作不會傳回可繼續執行的任務定義。 |
|
| Id |
integer |
被刪除任務定義的內部唯一 ID。 |
1 |
| JobName |
string |
刪除前的原始任務名稱,即本次請求的 Name。 |
semantic-job-demo |
| ArchivedJobName |
string |
系統為歸檔記錄產生的任務名稱,僅用於區分已刪除的記錄,無法再用於 RunSemanticJob。 |
semantic-job-demo-archived |
| Deleted |
boolean |
是否已完成刪除處理;值為 true 表示該任務已歸檔刪除。 |
回應欄位含義及後續呼叫關係請參閱各欄位說明。
樣本
正常返回樣本
JSON格式
{
"RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
"Success": false,
"Data": {
"Id": 1,
"JobName": "semantic-job-demo",
"ArchivedJobName": "semantic-job-demo-archived",
"Deleted": false
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。