All Products
Search
Document Center

AnalyticDB:UpsertCollectionData

最終更新日:Dec 20, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:UpsertCollectionDatacreate
*Collection
acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringNo

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
CollectionstringYes

The name of the collection.

document
NamespacestringNo

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
NamespacePasswordstringYes

The password of the namespace.

testpassword
Rowsarray<object>No

The vector data that you want to upload.

objectNo
IdstringNo

The unique ID of vector data. If you leave this parameter empty, a UUID is automatically generated.

doca-1234
MetadataobjectNo

The metadata of vector data. The field information about this parameter is the same as that in the CreateCollection operation.

stringNo

The metadata of vector data.

{"title":"test title", "content": "test content"}
VectorarrayYes

The vector data. The length of vector data is the same as the value of Dimension in the CreateCollection operation.

doubleNo

The vector data.

1.234
RegionIdstringYes

The region ID of the instance.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
WorkspaceIdstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

The returned message.

Successful
Statusstring

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 timeSummary of changesOperation
2024-08-04The request parameters of the API has changedView Change Details
2023-11-07The internal configuration of the API is changed, but the call is not affectedView Change Details