ListVectorIndexes - Object Storage Service: Central de Documentação do Alibaba Cloud

Notas de uso

A operação ListVectorIndexes retorna no máximo 500 índices por chamada. Para obter a próxima página de resultados, use o token de paginação da resposta atual.

Permissões

Uma conta Alibaba Cloud tem permissões completas para acessar todas as operações de API. Por padrão, usuários RAM e funções RAM não podem chamar esta operação. Crie e anexe uma RAM policy ou uma bucket policy para conceder as permissões necessárias.

API	Action	Descrição
ListVectorIndexes	`oss:ListVectorIndexes`	Lista índices vetoriais.

Sintaxe da requisição

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"
}

Cabeçalhos da requisição

Esta operação usa apenas cabeçalhos de requisição comuns. Para mais informações, consulte Common HTTP headers.

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
maxResults	Integer	Não	100	Número máximo de índices a retornar. Valores válidos: 0 a 500. Se este parâmetro não for especificado ou for definido como 0, o valor padrão será 100.
nextToken	String	Não	myindex1	Token de paginação usado para recuperar a próxima página de resultados. Para continuar a listagem, defina este parâmetro com o valor de `nextToken` da resposta anterior.
prefix	String	Não	my	Filtra os resultados para incluir apenas índices cujos nomes começam com este prefixo.

Cabeçalhos da resposta

Esta operação usa apenas cabeçalhos de resposta comuns. Para mais informações, consulte Common HTTP headers.

Elementos da resposta

Parâmetro	Tipo	Exemplo	Descrição
indexes	Array of objects	-	Contêiner dos índices vetoriais.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Nome do recurso (ARN) do vector bucket ao qual o índice pertence, no formato acs:ossvector:{region}:{accountId}:{bucketName}. Nó pai: index
indexName	String	vectorindex1	Nome do índice vetorial. Nó pai: `index`
createTime	String	2025-04-17T10:56:21.000Z	Horário de criação do índice vetorial, em UTC. Nó pai: `index`
dataType	String	float32	Tipo de dados do vetor. Nó pai: `index`
dimension	Integer	1024	Dimensão do vetor. Nó pai: `index`
distanceMetric	String	euclidean	Métrica de distância. Nó pai: `index`
metadata	Container	-	Configuração de metadados. Nó pai: `index`
nonFilterableMetadataKeys	Array of strings	["category", "timestamp"]	Lista de campos de metadados que não podem ser usados para filtragem. Nó pai: `metadata`
status	String	enable	Status do índice vetorial. Valores válidos: `creating` `enable` `deleting`
nextToken	String	myindex1	Token de paginação. Se a resposta for truncada, use este token na próxima requisição para recuperar mais resultados.

Exemplos

Exemplo de requisição

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"
}

Exemplo de resposta

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",
         "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",
         "dataType": "float32",
         "dimension": 512,
         "distanceMetric": "cosine",
         "metadata": { 
             "nonFilterableMetadataKeys": ["type", "source"]
          },
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

SDK

Use os seguintes SDKs para chamar esta operação:

ossutil CLI

Para o comando ossutil correspondente, consulte list-vector-indexes.

Códigos de erro

Código de erro	Código de status HTTP	Descrição
VectorIndexParameterInvalid	400	O parâmetro do índice vetorial fornecido na requisição é inválido.
MalformedJson	400	O corpo da requisição não está em um formato JSON válido.
AccessDenied	403	Acesso negado. Possíveis causas: A requisição não inclui as informações de autenticação necessárias. Você não tem as permissões necessárias para executar a operação.