調用ListVectorIndexes介面列舉向量Bucket中的所有向量索引。
注意事項
每次 ListVectorIndexes 最大返回索引個數 500，可分頁擷取下一批索引列表
ListVectorIndexes 並發度上限 16 個
許可權說明
阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權，需要阿里雲帳號或帳號管理員通過RAM Policy或Bucket Policy授予操作許可權。
API | Action | 說明 |
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 | 索引當前的狀態。取值：
|
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 | 返回該錯誤的可能原因如下：
|