通过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 入参发生变更 | 查看变更详情 |