Call DescribeCollection to query vector collection information - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the information about a vector collection.

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:DescribeCollection

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 the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-bp152460513z****
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 elements

Element	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-bp152460513z****
RegionId	string	The region ID of the instance.	cn-hangzhou
Namespace	string	The name of the namespace.	mynamespace
Message	string	The returned message.	success
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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.