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

Enumera todos los índices vectoriales de un bucket vectorial.

Notas de uso

La operación ListVectorIndexes devuelve un máximo de 500 índices por llamada. Para obtener la siguiente página de resultados, use el token de paginación de la respuesta actual.

Permisos

Una cuenta de Alibaba Cloud tiene permisos completos para acceder a todas las operaciones de API. De forma predeterminada, los usuarios y roles de RAM no pueden invocar esta operación. Cree y adjunte una RAM policy o un bucket policy para otorgar los permisos obligatorios.

API	Acción	Descripción
ListVectorIndexes	`oss:ListVectorIndexes`	Enumera los índices vectoriales.

Sintaxis de la solicitud

POST /?listVectorIndexes HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
Content-type: application/json

{
   "maxResults": int,
   "nextToken": "string",
   "prefix": "string"
}

Encabezados de solicitud

Esta operación usa únicamente encabezados de solicitud comunes. Para más información, consulte Common HTTP headers.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
maxResults	Integer	No	100	Número máximo de índices que se devuelven. Valores válidos: de 0 a 500. Si no se especifica este parámetro o se establece en 0, el valor predeterminado es 100.
nextToken	String	No	myindex1	Token de paginación que se usa para obtener la siguiente página de resultados. Para continuar con la enumeración, establezca este parámetro con el valor `nextToken` de la respuesta anterior.
prefix	String	No	my	Filtra los resultados para incluir solo los índices cuyo nombre comienza con este prefijo.

Encabezados de respuesta

Esta operación usa únicamente encabezados de respuesta comunes. Para más información, consulte Common HTTP headers.

Elementos de respuesta

Parámetro	Tipo	Ejemplo	Descripción
indexes	Array of objects	-	Contenedor de los índices vectoriales.
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 vectorial. Nodo padre: `index`
createTime	String	2025-04-17T10:56:21.000Z	Hora de creación del índice vectorial, en formato UTC. Nodo padre: `index`
dataType	String	float32	Tipo de datos del vector. Nodo padre: `index`
dimension	Integer	1024	Dimensión del vector. Nodo padre: `index`
distanceMetric	String	euclidean	Métrica de distancia. Nodo padre: `index`
metadata	Container	-	Configuración de metadatos. Nodo padre: `index`
nonFilterableMetadataKeys	Array of strings	["category", "timestamp"]	Lista de campos de metadatos que no se pueden usar para filtrar. Nodo padre: `metadata`
status	String	enable	Estado del índice vectorial. Valores válidos: `creating` `enable` `deleting`
mode	String	fusion	Modo del índice. Valores válidos: standard (modo estándar) fusion (modo fusión) Nodo padre: `index`
nextToken	String	myindex1	Token de paginación. Si la respuesta se trunca, use este token en la siguiente solicitud para obtener más resultados.

Nota

Los elementos de respuesta a continuación se devuelven para los índices en modo estándar. Los índices en modo estándar y en modo fusión pueden coexistir en el mismo bucket vectorial, y la lista devuelta incluye ambos tipos. Distinga cada tipo mediante el campo mode. Para los índices en modo fusión, solo se devuelve información básica como bucketArn, indexName, createTime, mode y status. Para obtener la configuración completa del esquema de un índice en modo fusión, invoque la operación GetVectorIndex.

Ejemplos

Modo estándar

Ejemplo de solicitud

POST /?listVectorIndexes 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
Content-type: application/json

{
   "maxResults": 10,
   "prefix": "my"
}

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

{
   "indexes": [ 
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T10:56:21.000Z",
         "indexName": "vectorindex1",
         "mode": "standard",
         "dataType": "float32",
         "dimension": 1024,
         "distanceMetric": "euclidean",
         "metadata": { 
             "nonFilterableMetadataKeys": ["category", "timestamp"]
          },
         "status": "enable"
      },
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T11:20:15.000Z",
         "indexName": "vectorindex2",
         "mode": "standard",
         "dataType": "float32",
         "dimension": 512,
         "distanceMetric": "cosine",
         "metadata": { 
             "nonFilterableMetadataKeys": ["type", "source"]
          },
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

Modo fusión

Ejemplo de solicitud

POST /?listVectorIndexes 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
Content-type: application/json

{
   "maxResults": 10,
   "prefix": "my"
}

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

{
   "indexes": [ 
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T10:56:21.000Z",
         "indexName": "vectorindex1",
         "mode": "standard",
         "dataType": "float32",
         "dimension": 1024,
         "distanceMetric": "euclidean",
         "metadata": { 
             "nonFilterableMetadataKeys": ["category", "timestamp"]
          },
         "status": "enable"
      },
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T11:20:15.000Z",
         "indexName": "vectorindex2",
         "mode": "fusion",
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

SDK

Invoque esta operación con los SDK a continuación:

CLI de ossutil

Para conocer el comando de ossutil correspondiente, consulte list-vector-indexes.

Códigos de error

Código de error	Código de estado HTTP	Descripción
VectorIndexParameterInvalid	400	El parámetro del índice vectorial proporcionado en la solicitud no es válido.
MalformedJson	400	El cuerpo de la solicitud no tiene un formato JSON válido.
AccessDenied	403	Acceso denegado. Posibles causas: La solicitud no incluye la información de autenticación obligatoria. No cuenta con los permisos necesarios para ejecutar la operación.