ListVectorIndexes を呼び出して、ベクターバケット内のすべてのベクターインデックスをリストできます。
重要事項
ListVectorIndexes は、呼び出しごとに最大 500 個のインデックスを返します。次のバッチのインデックスを取得するには、ページネーションを使用します。
ListVectorIndexes の最大同時実行数は 16 です。
権限
デフォルトでは、Alibaba Cloud アカウントは完全な権限を持っています。ただし、RAM ユーザーと RAM ロールには権限がありません。Alibaba Cloud アカウントまたは管理者は、RAM ポリシー または バケットポリシー を使用して権限を付与する必要があります。
API | アクション | 説明 |
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 | value | いいえ | 100 | 返されるインデックスの最大数。有効な値: 0 ～ 500。このパラメーターを指定しないか、0 に設定した場合、デフォルト値は 100 です。 |
nextToken | String | いいえ | myindex1 | nextToken の後にアルファベット順で最初に来るインデックスから結果の返却を開始します。 |
prefix | String | いいえ | my | プレフィックスでベクターインデックスを照合します。 |
レスポンスヘッダー
この操作では、共通レスポンスヘッダーのみを使用します。詳細については、「共通 HTTP ヘッダー」をご参照ください。
レスポンス要素
名前 | 型 | 例の値 | 説明 |
indexes | オブジェクトの配列 | - | ベクターインデックス情報を含む配列。 |
indexName | String | vectorindex1 | インデックスの名前。 親ノード：index |
createTime | String | 2025-04-17T10:56:21.000Z | インデックスが作成された時刻 (GMT 形式)。 親ノード：index |
dataType | String | float32 | ベクターのデータ型。 親ノード：index |
dimension | Integer | 1024 | ベクターのディメンション。 親ノード：index |
distanceMetric | String | euclidean | 距離メトリック関数。 親ノード：index |
metadata | Container | - | メタデータ構成。 親ノード：index |
nonFilterableMetadataKeys | Array of strings | ["category", "timestamp"] | フィルター不可能なメタデータフィールドのリスト。 親ノード：metadata |
status | String | enable | インデックスの現在のステータス。有効な値:
|
nextToken | String | myindex1 | 次のページへのページネーショントークン。この呼び出しがすべての結果を返さない場合、レスポンスには次のクエリ用の 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"
}SDK
ListVectorIndexes 用の SDK:
ossutil コマンド
ListVectorIndexes に対応する ossutil コマンドについては、「list-vector-indexes」をご参照ください。
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
VectorIndexParameterInvalid | 400 | リクエスト内のベクターインデックスパラメーターが無効です。 |
MalformedJson | 400 | リクエストボディ内の JSON 形式が無効です。 |
AccessDenied | 403 | 考えられる原因:
|