すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:ListVectors

最終更新日:Feb 12, 2026

ListVectors 操作は、ベクトルインデックス内のすべてのベクトルデータをリストします。

権限

デフォルトでは、Alibaba Cloud アカウントは完全な権限を持っています。デフォルトでは、Alibaba Cloud アカウント配下の Resource Access Management (RAM) ユーザーおよび RAM ロールには権限がありません。Alibaba Cloud アカウントまたは管理者は、RAM ポリシーまたはバケットポリシーを使用して権限を付与する必要があります。

API

アクション

説明

ListVectors

oss:ListVectors

ベクトルデータをリストします。

リクエスト構文

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

{
   "indexName": "string",
   "maxResults": int,
   "nextToken": "string",
   "returnData": boolean,
   "returnMetadata": boolean,
   "segmentCount": int,
   "segmentIndex": int
}

リクエストヘッダー

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

リクエストパラメーター

名前

データ型

必須

説明

indexName

String

はい

vectorindex1

インデックスの名前。

maxResults

いいえ

500

各呼び出しで返される結果の最大数。デフォルト値は 500 です。最大値は 1000 です。

nextToken

String

いいえ

CAESCG15aC1xxxxx

クエリートークン。このパラメーターには、前回の呼び出しで返された nextToken の値を設定します。最初の呼び出しでは、このパラメーターを空のままにします。トークンの長さは 1 ~ 2,048 バイトです。

returnData

Boolean

いいえ

false

ベクトルデータを返すかどうかを指定します。有効な値:

  • true

  • false (デフォルト)

returnMetadata

Boolean

いいえ

false

メタデータを返すかどうかを指定します。有効な値:

  • true

  • false (デフォルト)

segmentCount

いいえ

1

並列 ListVectors 呼び出しの場合、並列処理の次数を指定します。最大値は 16 です。シリアル呼び出しの場合、このパラメーターを 1 に設定します。

segmentIndex

いいえ

0

並列 ListVectors 呼び出しの場合、セグメントのインデックスは segmentCount 未満である必要があります。

レスポンスヘッダー

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

レスポンス要素

名前

データ型

説明

nextToken

String

CAESCG15aC2xxxxx

結果の次のページへのトークン。このパラメーターが空の場合、すべての結果が返されています。

vectors

オブジェクトの配列

N/A

返されたベクターのリスト。

key

String

doc-001

ベクターのプライマリキー。

親ノード: vectors

data

Object

N/A

ベクトルデータ。この要素は、returnData が true に設定されている場合にのみ返されます。

親ノード: vectors

metadata

Object

N/A

メタデータ。この要素は、returnMetadata が true に設定されている場合にのみ返されます。

親ノード: vectors

リクエスト例

POST /?listVectors 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

{
   "indexName": "vectorindex1",
   "maxResults": 10,
   "returnData": true,
   "returnMetadata": true
}

レスポンス例

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

{
   "nextToken": "CAESCG15aC2xxxxx",
   "vectors": [ 
      { 
         "data": {
            "float32": [0.1, 0.2, 0.3, 0.4, 0.5]
         },
         "key": "doc-001",
         "metadata": {
             "category": ["technology", "ai"],
             "title": "Introduction to Vector Search"
         }
      },
      { 
         "data": {
            "float32": [0.2, 0.3, 0.4, 0.5, 0.6]
         },
         "key": "doc-002",
         "metadata": {
             "category": ["science"],
             "title": "Advanced Vector Operations"
         }
      }
   ]
}

SDK

ListVectors 操作は、以下のソフトウェア開発キット (SDK) でサポートされています。

ossutil コマンドラインインターフェイス

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

エラーコード

エラーコード

HTTP ステータスコード

説明

VectorIndexParameterInvalid

400

リクエストで指定されたベクトルインデックスパラメーターが無効です。

MalformedJson

400

リクエストボディの JSON 形式が無効です。

AccessDenied

403

このエラーは、以下の理由で返されます。

  • ユーザー認証情報がリクエストに含まれていません。

  • 操作に必要な権限がありません。

NoSuchVectorIndex

404

指定されたベクトルインデックスが存在しません。

QpsLimitExceeded

503

QPS (Queries Per Second) 速度制限により、リクエストレートが制限されています。