GetUpsertCollectionDataJob - AnalyticDB - Alibaba Cloud Documentation Center

Queries the progress and result of an asynchronous vector data upload job by using a job ID.

Operation description

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

Note We recommend that you evaluate the amount of time required for the upload job based on 1,000 data entries every second, and then query the job progress every 5 seconds. The timeout period can be set to 30 minutes after the evaluated amount of time.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:GetUpsertCollectionDataJob	create	*Collection `acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	No	The instance ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within 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 the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.	mynamespace
NamespacePassword	string	Yes	The password of the namespace. Note The value of this parameter is specified when you call the CreateNamespace operation.	testpassword
JobId	string	Yes	The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID.	231460f8-75dc-405e-a669-0c5204887e91
WorkspaceId	string	No	The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.	gp-ws-*****

Response parameters

Parameter	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 information about the vector data upload job.
Id	string	The job ID.	231460f8-75dc-405e-a669-0c5204887e91
Completed	boolean	Indicates whether the operation 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 of this parameter indicates the number of data entries that have been uploaded.	1600

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-04	The request parameters of the API has changed	View Change Details