ListVectorIndexes - Object Storage Service - Centre de documentation Alibaba Cloud

Notes d'utilisation

L'opération ListVectorIndexes renvoie au maximum 500 index par appel. Pour récupérer la page de résultats suivante, utilisez le jeton de pagination fourni dans la réponse actuelle.

Autorisations

Un compte Alibaba Cloud dispose de toutes les autorisations nécessaires pour accéder à l'ensemble des opérations API. Par défaut, les utilisateurs RAM et les rôles RAM ne peuvent pas appeler cette opération. Vous devez créer et associer une politique RAM ou une politique de bucket afin d'accorder les autorisations requises.

API

Action

Description

ListVectorIndexes

oss:ListVectorIndexes

Répertorie les index vectoriels.

Syntaxe de la requête

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

En-têtes de requête

Cette opération utilise uniquement des en-têtes de requête communs. Pour plus d'informations, consultez la section En-têtes HTTP communs.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

maxResults

Integer

Non

100

Nombre maximal d'index à renvoyer. Valeurs valides : de 0 à 500. Si ce paramètre n'est pas spécifié ou s'il est défini sur 0, la valeur par défaut est 100.

nextToken

String

Non

myindex1

Jeton de pagination utilisé pour récupérer la page de résultats suivante. Pour poursuivre la liste, définissez ce paramètre sur la valeur nextToken issue de la réponse précédente.

prefix

String

Non

my

Filtre les résultats afin d'inclure uniquement les index dont les noms commencent par ce préfixe.

En-têtes de réponse

Cette opération utilise uniquement des en-têtes de réponse communs. Pour plus d'informations, consultez la section En-têtes HTTP communs.

Éléments de réponse

Paramètre	Type	Exemple	Description
indexes	Tableau d'objets	-	Conteneur pour les index vectoriels.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Nom de ressource (ARN) du bucket vectoriel auquel appartient l'index, au format acs:ossvector:{region}:{accountId}:{bucketName}. Nœud parent : index
indexName	String	vectorindex1	Nom de l'index vectoriel. nœud parent : `index`
createTime	String	2025-04-17T10:56:21.000Z	Heure de création de l'index vectoriel, au format UTC. nœud parent : `index`
dataType	String	float32	Type de données du vecteur. nœud parent : `index`
dimension	Integer	1024	Dimension du vecteur. nœud parent : `index`
distanceMetric	String	euclidean	Métrique de distance. nœud parent : `index`
metadata	Conteneur	-	Configuration des métadonnées. nœud parent : `index`
nonFilterableMetadataKeys	Tableau de chaînes	["category", "timestamp"]	Liste des champs de métadonnées qui ne peuvent pas être utilisés pour le filtrage. nœud parent : `metadata`
status	String	enable	Statut de l'index vectoriel. Valeurs valides : `creating` `enable` `deleting`
mode	String	fusion	Mode de l'index. Valeurs valides : standard (mode standard) fusion (mode fusion) nœud parent : `index`
nextToken	String	myindex1	Jeton de pagination. Si la réponse est tronquée, utilisez ce jeton dans la requête suivante pour récupérer davantage de résultats.

Remarque

Les éléments de réponse précédents sont renvoyés pour les index en mode standard. Les index en mode standard et en mode fusion peuvent coexister au sein du même bucket vectoriel ; la liste renvoyée inclut les index des deux modes, que vous pouvez distinguer grâce au champ mode. Pour les index en mode fusion, seules les informations de base telles que bucketArn, indexName, createTime, mode et status sont renvoyées. Pour obtenir la configuration complète du schéma d'un index en mode fusion, appelez l'opération GetVectorIndex.

Exemples

Mode standard

Exemple de requête

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

Exemple de réponse

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

Mode fusion

Exemple de requête

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

Exemple de réponse

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

Appelez cette opération à l'aide des SDK suivants :

CLI ossutil

Pour la commande ossutil correspondante, consultez la section list-vector-indexes.

Codes d'erreur

Code d'erreur	Code d'état HTTP	Description
VectorIndexParameterInvalid	400	Le paramètre d'index vectoriel fourni dans la requête n'est pas valide.
MalformedJson	400	Le corps de la requête n'est pas au format JSON valide.
AccessDenied	403	Accès refusé. Causes possibles : La requête n'inclut pas les informations d'authentification requises. Vous ne disposez pas des autorisations nécessaires pour effectuer l'opération.