Call the GetVectorIndex API to retrieve vector index information - Object Storage Service

Call the GetVectorIndex operation to retrieve details about a vector index.

Permissions

By default, an Alibaba Cloud account has full permissions. Resource Access Management (RAM) users and RAM roles under an Alibaba Cloud account have no permissions by default. An Alibaba Cloud account or account administrator must grant permissions using a RAM policy or a bucket policy.

API	Action	Description
GetVectorIndex	`oss:GetVectorIndex`	Gets vector index information.

Request syntax

POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
{
   "indexName": "string"
}

Request headers

This operation uses only common request headers. For more information, see Common HTTP headers.

Request parameters

Name	Data Types	Required	Example	Description
indexName	String	Yes	vectorindex1	The index name.

Response headers

This operation uses only common response headers. For more information, see Common HTTP headers.

Response elements

Name	Type	Example	Description
index	Container	-	A container that holds vector index information.
indexName	String	vectorindex1	The name of the index. Parent node: index
createTime	String	2025-04-17T10:56:21.000Z	The time when the index was created, in GMT format. Parent node: index
dataType	String	float32	The vector data type. Parent node: index
dimension	Integer	1024	The vector dimensions. Parent node: index
distanceMetric	String	euclidean	The distance measure function. Parent node: index
metadata	Container	-	The metadata configuration. Parent node: index
nonFilterableMetadataKeys	Array of strings	["category", "timestamp"]	A list of non-filterable metadata fields. Parent node: metadata
status	String	enable	The current status of the index. Valid values: creating Enabled (active) deleting

Examples

Sample request

POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: Thu, 17 Apr 2025 01:33:47 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218

{
   "indexName": "vectorindex1"
}

Sample response

HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Thu, 17 Apr 2025 01:33:47 GMT
Connection: keep-alive
Server: AliyunOSS
Content-type: application/json

{
   "index": { 
      "createTime": "2025-04-17T10:56:21.000Z",
      "dataType": "float32",
      "dimension": 1024,
      "distanceMetric": "euclidean",
      "metadata": { 
         "nonFilterableMetadataKeys": ["category", "timestamp"]
      },
      "status": "enable"
   }
}

SDK

The following SDKs support the GetVectorIndex operation:

ossutil command-line tool

For the ossutil command that corresponds to the GetVectorIndex operation, see get-vector-index.

Error codes

Error code	HTTP status code	Description
VectorIndexParameterInvalid	400	The vector index parameter in the request is invalid.
MalformedJson	400	The JSON format in the request body is invalid.
AccessDenied	403	Possible causes: You did not include authentication information in the request. You do not have the required permissions.
NoSuchVectorIndex	404	The specified vector index does not exist.