Use GetUpsertCollectionDataJob to query the progress of a vector data upload job - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

This operation is related to UpsertCollectionDataAsync. You can call UpsertCollectionDataAsync to create an upload job and obtain a job ID, and then call GetUpsertCollectionDataJob to query the job execution details.

Note

We recommend that you estimate the time required for the upload job based on 1,000 data entries per second, and then query the job progress every 5 seconds. Set the timeout period to 30 minutes after the estimated time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:GetUpsertCollectionDataJob

create

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	No	The instance ID. Note You can call the DescribeDBInstances operation to query information about all AnalyticDB for PostgreSQL instances in a region, including instance IDs.	gp-xxxxxxxxx
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
Collection	string	Yes	The name of the collection. Note You can call the ListCollections operation to query a list of collections.	document
Namespace	string	No	The name of the namespace. Default value: public. Note You can call CreateNamespace to create a namespace and ListNamespaces to query a list of namespaces.	mynamespace
NamespacePassword	string	Yes	The password of the namespace. Note This value is specified when you call the CreateNamespace operation.	testpassword
JobId	string	Yes	The ID of the vector data upload job. The job ID is returned when you call `UpsertCollectionDataAsync`.	231460f8-75dc-405e-a669-0c5204887e91
WorkspaceId	string	No	The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify either WorkspaceId or DBInstanceId. If you specify both, WorkspaceId takes effect.	gp-ws-*****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	The status of the operation. Valid values: success fail	success
Message	string	The returned message.	success
Job	object	The details of the vector data upload job.
Id	string	The job ID.	231460f8-75dc-405e-a669-0c5204887e91
Completed	boolean	Indicates whether the job is complete.	false
CreateTime	string	The time when the job was created.	2024-01-08 16:52:04.864664
UpdateTime	string	The time when the job was updated.	2024-01-08 16:53:04.864664
Status	string	The status of the job. Note Valid values: Success Failed (See the Error parameter for failure reasons.) Cancelling Cancelled Start Running	Success
Error	string	The error message.	Failed to connect database.
Progress	integer	The progress of the vector data upload job. The value indicates the number of data entries that have been uploaded.	1600

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.