通過JobId取消非同步上傳文檔的任務。
介面說明
此介面為 UploadDocumentAsync 的相關介面。用於取消上傳任務。
當任務已經處理成功、失敗、已取消時,不能再次調用取消介面。調用取消介面僅中斷上傳任務,已經寫的資料,需要使用者自行或者調用 DeleteCollectionData 介面刪除,或者再次使用相同 FileName 調用上傳覆蓋。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
gpdb:CancelUploadDocumentJob |
update |
*Document
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
已經開啟向量引擎最佳化執行個體 ID。 說明
您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情,包括執行個體 ID。 |
gp-xxxxxxxxx |
| Namespace |
string |
否 |
命名空間,預設為 public。 說明
您可以通過 CreateNamespace 介面建立,通過 ListNamespaces 介面查看列表。 |
mynamespace |
| Collection |
string |
是 |
文件庫名稱。 說明
由 CreateDocumentCollection 介面建立。您可以調用 ListDocumentCollections 介面查看已經建立的文件庫。 |
document |
| RegionId |
string |
是 |
執行個體所在 Region ID。 |
cn-hangzhou |
| NamespacePassword |
string |
是 |
命名空間對應的密碼。 說明
本值為 CreateNamespace 介面指定。 |
testpassword |
| JobId |
string |
是 |
上傳文檔的任務 ID,由 |
231460f8-75dc-405e-a669-0c5204887e91 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
ABB39CC3-4488-4857-905D-2E4A051D0521 |
| Message |
string |
返回資訊。 |
success |
| Status |
string |
API 執行狀態,取值如下:
|
success |
樣本
正常返回樣本
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "success",
"Status": "success"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。