通過JobId獲取異步上傳向量數據的任務的進度和結果。
接口說明
此接口為UpsertCollectionDataAsync的相關接口。可通過UpsertCollectionDataAsync創建一個上傳任務，并得到一個 JobId，然后通過此接口查看 Job 的執行信息。
說明
使用建議：可按照 1000 條向量數據需要 1s 的時間初步預估上傳任務的耗時，然后每 5s 查詢一次任務進度。超時建議設置為去掉初步評估的時間消耗后 30min。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| gpdb:GetUpsertCollectionDataJob | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 否 | 實例 ID。 說明
您可以調用 DescribeDBInstances 接口查看目標地域下所有的 AnalyticDB PostgreSQL 實例的詳情，包括實例 ID。
| gp-xxxxxxxxx |
| RegionId | string | 是 | 實例所在 Region ID。 | cn-hangzhou |
| Collection | string | 是 | 集合名。 說明
您可以通過 ListCollections 接口查看列表。
| document |
| Namespace | string | 否 | 命名空間，默認為 public。 說明
您可以通過 CreateNamespace 接口創建，通過 ListNamespaces 接口查看列表。
| mynamespace |
| NamespacePassword | string | 是 | 命名空間對應的密碼。 說明
本值為 CreateNamespace 接口指定。
| testpassword |
| JobId | string | 是 | 上傳向量數據的任務 ID，由 | 231460f8-75dc-405e-a669-0c5204887e91 |
| WorkspaceId | string | 否 | 多數據庫實例組成的 Workspace 的 Id。此參數和 DBInstanceId 參數不能同時為空，當和 DBInstanceId 同時指定時以此參數為準。 | gp-ws-***** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Status": "success",
"Message": "success",
"Job": {
"Id": "231460f8-75dc-405e-a669-0c5204887e91",
"Completed": false,
"CreateTime": "2024-01-08 16:52:04.864664",
"UpdateTime": "2024-01-08 16:53:04.864664",
"Status": "Success",
"Error": "Failed to connect database.",
"Progress": 1600
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-04 | OpenAPI 入參發生變更 | 查看變更詳情 |