UpsertCollectionData - AnalyticDB

Uploads vector data to a vector collection.

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:
- The required resource types are displayed in bold characters.
- 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:UpsertCollectionData	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
Collection	string	Yes	The name of the collection.	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.	testpassword
Rows	array<object>	No	The vector data that you want to upload.
	object	No
Id	string	No	The unique ID of vector data. If you leave this parameter empty, a UUID is automatically generated.	doca-1234
Metadata	object	No	The metadata of vector data. The field information about this parameter is the same as that in the CreateCollection operation.
	string	No	The metadata of vector data.	{"title":"test title", "content": "test content"}
Vector	array	Yes	The vector data. The length of vector data is the same as the value of Dimension in the CreateCollection operation.
	double	No	The vector data.	1.234
RegionId	string	Yes	The region ID of the instance. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
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
Message	string	The returned message.	Successful
Status	string	Indicates whether the request was successful. Valid values: success fail	success

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success"
}

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
2023-11-07	The internal configuration of the API is changed, but the call is not affected	View Change Details