Object Storage Service:ListVectorIndexes

使用上の注意

• ListVectorIndexes API は、1 回の呼び出しで最大 500 個のインデックスを返します。次の結果ページを取得するには、現在のレスポンスのページネーショントークンを使用してください。

• ListVectorIndexes API は、最大 16 の同時呼び出しをサポートします。

権限

Alibaba Cloud アカウントは、すべての API 操作にアクセスするための完全な権限を有します。デフォルトでは、RAM ユーザーと RAM ロールはこの API を呼び出すことはできません。必要な権限を付与するには、RAM ポリシーまたはバケットポリシーを作成してアタッチする必要があります。

リクエスト構文

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

リクエストヘッダー

この操作は、共通のリクエストヘッダーのみを使用します。詳細については、「共通 HTTP ヘッダー」をご参照ください。

リクエストパラメーター

レスポンスヘッダー

この操作は、共通のレスポンスヘッダーのみを使用します。詳細については、「共通 HTTP ヘッダー」をご参照ください。

レスポンス要素

例

リクエスト例

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

レスポンス例

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

SDK

この API は、次の SDK を使用して呼び出すことができます：

• ベクターインデックスの一覧表示 (Python SDK V2)

• ベクターインデックスの一覧表示 (Go SDK V2)

ossutil CLI

対応する ossutil コマンドについては、「list-vector-indexes」をご参照ください。

エラーコード