GetVectorIndex - Object Storage Service - Centro de documentación de Alibaba Cloud

Recupera la configuración de un índice vectorial, incluido el tipo de datos, las dimensiones y la métrica de distancia.

Permisos

Las cuentas de Alibaba Cloud tienen permisos completos de forma predeterminada. Los usuarios de RAM y los roles de RAM requieren autorización explícita mediante una RAM policy o un bucket policy.

API	Acción	Descripción
GetVectorIndex	`oss:GetVectorIndex`	Recupera información del índice vectorial.

Sintaxis de la solicitud

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

Encabezados de solicitud

Esta operación utiliza únicamente los common request headers.

Parámetros de solicitud

Nombre	Tipo de dato	Obligatorio	Ejemplo	Descripción
indexName	string	Sí	vectorindex1	Nombre del índice.

Encabezados de respuesta

Esta operación utiliza únicamente los common response headers.

Elementos de respuesta

Nombre	Tipo de dato	Ejemplo	Descripción
index	container	-	Contenedor de la información del índice vectorial.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Nombre del recurso (ARN) del bucket vectorial al que pertenece el índice, con el formato acs:ossvector:{region}:{accountId}:{bucketName}. Nodo padre: index
indexName	string	vectorindex1	Nombre del índice. Nodo padre: index
createTime	string	2025-04-17T10:56:21.000Z	Hora de creación del índice en GMT. Nodo padre: index
dataType	string	float32	Tipo de dato del vector. Nodo padre: index
dimension	Integer	1024	Número de dimensiones del vector. Nodo padre: index
distanceMetric	string	euclidean	Función de métrica de distancia. Nodo padre: index
metadata	container	-	Configuración de metadatos. Nodo padre: index
nonFilterableMetadataKeys	string array	["category", "timestamp"]	Campos de metadatos no filtrables. Nodo padre: metadata
status	string	enable	Estado del índice. Valores válidos: creating enable deleting

Ejemplos

Ejemplo de solicitud

POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.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"
}

Ejemplo de respuesta

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": { 
      "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
      "createTime": "2025-04-17T10:56:21.000Z",
      "indexName": "vectorindex1",
      "dataType": "float32",
      "dimension": 1024,
      "distanceMetric": "euclidean",
      "metadata": { 
         "nonFilterableMetadataKeys": ["category", "timestamp"]
      },
      "status": "enable"
   }
}

SDK

SDK disponibles para GetVectorIndex:

Interfaz de línea de comandos ossutil

Ejecute GetVectorIndex desde la línea de comandos con ossutil get-vector-index.

Códigos de error

Código de error	Código de estado HTTP	Descripción
VectorIndexParameterInvalid	400	Parámetro de índice vectorial no válido en la solicitud.
MalformedJson	400	JSON no válido en el cuerpo de la solicitud.
AccessDenied	403	Posibles causas: Falta información de autenticación en la solicitud. Permisos insuficientes.
NoSuchVectorIndex	404	El índice vectorial no existe.