ListVectorIndexes API リファレンス - OSS - Alibaba Cloud - Object Storage Service

ベクトルバケット内のすべてのベクトルインデックスを一覧表示します。

注意事項

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

権限

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

API	アクション	説明
ListVectorIndexes	`oss:ListVectorIndexes`	ベクトルインデックスを一覧表示します。

リクエスト構文

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

リクエストヘッダー

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
maxResults	Integer	いいえ	100	返されるインデックスの最大数です。有効値：0～500。このパラメーターが指定されていない場合、または 0 に設定されている場合、デフォルト値は 100 です。
nextToken	String	いいえ	myindex1	結果の次のページを取得するためのページネーショントークンです。一覧表示を続行するには、このパラメーターを前のレスポンスの `nextToken` の値に設定します。
prefix	String	いいえ	my	このプレフィックスで始まる名前のインデックスのみを含むように結果をフィルタリングします。

レスポンスヘッダー

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

レスポンス要素

パラメーター	タイプ	例	説明
indexes	オブジェクトの配列	-	ベクトルインデックスのコンテナーです。
bucketArn	String	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	インデックスが属するベクトルバケットのリソース名 (ARN) です。形式は `acs:ossvector:{region}:{accountId}:{bucketName}` です。親ノード： `index`
indexName	String	vectorindex1	ベクトルインデックスの名前です。親ノード： `index`
createTime	String	2025-04-17T10:56:21.000Z	ベクトルインデックスが作成された時刻 (UTC) です。親ノード： `index`
dataType	String	float32	ベクトルのデータ型です。親ノード： `index`
dimension	Integer	1024	ベクトルの次元です。親ノード： `index`
distanceMetric	String	euclidean	距離メトリックです。親ノード： `index`
metadata	コンテナー	-	メタデータ設定です。親ノード： `index`
nonFilterableMetadataKeys	文字列の配列	["category", "timestamp"]	フィルタリングに使用できないメタデータフィールドのリストです。親ノード： `metadata`
status	String	enable	ベクトルインデックスのステータスです。有効値： `creating` `enable` `deleting`
nextToken	String	myindex1	ページネーショントークンです。レスポンスが切り捨てられた場合、このトークンを次のリクエストで使用して、続きの結果を取得します。

例

リクエスト例

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

SDK

この操作は、次の SDK を使用して呼び出せます。

ossutil CLI

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

エラーコード

エラーコード	HTTP ステータスコード	説明
VectorIndexParameterInvalid	400	リクエストで指定されたベクトルインデックスパラメーターが無効です。
MalformedJson	400	リクエストボディが有効な JSON 形式ではありません。
AccessDenied	403	アクセスが拒否されました。考えられる原因：リクエストに必要な認証情報が含まれていません。操作を実行するために必要な権限がありません。