GetUpsertCollectionDataJob - 获取异步上传向量数据任务_云原生数据仓库 AnalyticDB PostgreSQL版(AnalyticDB for PostgreSQL)-阿里云帮助中心

通过JobId获取异步上传向量数据的任务的进度和结果。

接口说明

此接口为UpsertCollectionDataAsync的相关接口。可通过UpsertCollectionDataAsync创建一个上传任务，并得到一个 JobId，然后通过此接口查看 Job 的执行信息。

说明使用建议：可按照 1000 条向量数据需要 1s 的时间初步预估上传任务的耗时，然后每 5s 查询一次任务进度。超时建议设置为去掉初步评估的时间消耗后 30min。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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，由`UpsertCollectionDataAsync`接口获得。	231460f8-75dc-405e-a669-0c5204887e91

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	此接口状态，取值说明： success：成功。 fail：失败。	success
Message	string	返回信息。	success
Job	object	上传向量数据的任务的详细信息。
Id	string	Job ID。	231460f8-75dc-405e-a669-0c5204887e91
Completed	boolean	操作是否完成。	false
CreateTime	string	任务创建时间。	2024-01-08 16:52:04.864664
UpdateTime	string	任务更新时间。	2024-01-08 16:53:04.864664
Status	string	任务状态。说明取值说明： Success：成功； Failed：失败，失败原因可查看 Error 字段； Cancelling：正在取消中； Cancelled：已取消； Start：开始； Running：执行中；	Success
Error	string	当前操作异常或者失败时的错误信息。	Failed to connect database.
Progress	integer	上传进度，此数值为已经上传的数据的条数。	1600

示例

正常返回示例

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
  }
}

错误码

访问错误中心查看更多错误码。