DescribeCollection - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about 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:
- 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:DescribeCollection	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
Namespace	string	No	The name of the namespace. Note You can call the ListNamespaces operation to query a list of namespaces.	mynamespace
NamespacePassword	string	Yes	The password of the namespace.	testpassword
Collection	string	Yes	The name of the collection. Note You can call the ListCollections operation to query a list of collections.	document
RegionId	string	Yes	The region ID of the instance.	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	The response parameters.
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Dimension	integer	The number of vector dimensions.	1024
FullTextRetrievalFields	string	The fields that are used for full-text search. Multiple fields are separated by commas (,).	title,content
Metadata	object	The metadata of vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type. Warning** Reserved fields such as id, vector, and to_tsvector cannot be used.
	string	The metadata.	{"title":"text","content":"text"}
Metrics	string	The distance metrics.	cosine
Parser	string	The analyzer that is used for full-text search.	zh_cn
DBInstanceId	string	The instance ID.	gp-xxxxxxxxx
RegionId	string	The region ID of the instance.	cn-hangzhou
Namespace	string	The name of the namespace.	mynamespace
Message	string	The returned message.	Successful
Status	string	Indicates whether the request was successful. Valid values: success fail	success
SupportSparse	boolean	Indicates whether sparse vectors are supported.	true
SparseVectorMetrics	string	The method that is used to create sparse vector indexes.	ip

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Dimension": 1024,
  "FullTextRetrievalFields": "title,content",
  "Metadata": {
    "key": {
      "title": "text",
      "content": "text"
    }
  },
  "Metrics": "cosine",
  "Parser": "zh_cn",
  "DBInstanceId": "gp-xxxxxxxxx",
  "RegionId": "cn-hangzhou",
  "Namespace": "mynamespace",
  "Message": "Successful",
  "Status": "success",
  "SupportSparse": true,
  "SparseVectorMetrics": "ip"
}

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