使用ListVectorIndexes接口列举向量索引-对象存储-阿里云

调用ListVectorIndexes接口列举向量Bucket中的所有向量索引。

注意事项

每次 ListVectorIndexes 最大返回索引个数 500，可分页获取下一批索引列表
ListVectorIndexes 并发度上限 16 个

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限，需要阿里云账号或账号管理员通过RAM Policy或Bucket Policy授予操作权限。

API	Action	说明
ListVectorIndexes	`oss:ListVectorIndexes`	列举向量索引。

请求语法

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

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

请求头

此接口仅涉及公共请求头。更多信息，请参见公共HTTP头定义。

请求参数

名称	数据类型	是否必选	示例值	描述
maxResults	数值	否	100	返回索引的最大个数，取值范围为0~500。不设置此参数或者设置为0时，默认值为100。
nextToken	字符串	否	myindex1	设定结果从 nextToken 之后按字母排序的第一个开始返回。
prefix	字符串	否	my	向量索引的前缀匹配。

响应头

此接口仅涉及公共响应头。更多信息，请参见公共HTTP头定义。

响应元素

名称	数据类型	示例值	描述
indexes	对象数组	-	保存向量索引信息的数组。
indexName	字符串	vectorindex1	索引名称。父节点：index
createTime	字符串	2025-04-17T10:56:21.000Z	索引的创建时间，格式为GMT时间。父节点：index
dataType	字符串	float32	向量数据类型。父节点：index
dimension	整型	1024	向量维度。父节点：index
distanceMetric	字符串	euclidean	距离度量函数。父节点：index
metadata	容器	-	元数据配置。父节点：index
nonFilterableMetadataKeys	字符串数组	["category", "timestamp"]	非过滤元数据字段列表。父节点：metadata
status	字符串	enable	索引当前的状态。取值： creating（创建中） enable（可用） deleting（删除中）
nextToken	字符串	myindex1	下一页查询凭证（Token）。如果本次没有返回全部结果，会包含nextToken用于后续查询。

示例

请求示例

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

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

返回示例

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": [ 
      { 
         "createTime": "2025-04-17T10:56:21.000Z",
         "indexName": "vectorindex1",
         "dataType": "float32",
         "dimension": 1024,
         "distanceMetric": "euclidean",
         "metadata": { 
             "nonFilterableMetadataKeys": ["category", "timestamp"]
          },
         "status": "enable"
      },
      { 
         "createTime": "2025-04-17T11:20:15.000Z",
         "indexName": "vectorindex2",
         "dataType": "float32",
         "dimension": 512,
         "distanceMetric": "cosine",
         "metadata": { 
             "nonFilterableMetadataKeys": ["type", "source"]
          },
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

错误码

错误码	HTTP状态码	描述
VectorIndexParameterInvalid	400	请求中提供的向量索引参数不合法。
MalformedJson	400	请求体中的 JSON 格式不符合规范。
AccessDenied	403	返回该错误的可能原因如下：发起请求时没有传入用户验证信息。没有操作权限。