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

Object Storage Service:ListVectors

最終更新日:Nov 09, 2025

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

権限

Alibaba Cloud アカウントは、デフォルトですべての権限を持っています。 Resource Access Management (RAM) ユーザーまたは Alibaba Cloud アカウント下の 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
}

リクエストヘッダー

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

リクエストパラメーター

名前

データ型

必須

説明

indexName

string

はい

vectorindex1

インデックスの名前。

maxResults

数値

いいえ

500

リクエストごとに返される結果の最大数。 デフォルト値は 500 です。 最大値は 1000 です。

nextToken

string

いいえ

CAESCG15aC-xxxxx

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

returnData

ブール値

いいえ

false

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

  • true

  • false (デフォルト)

returnMetadata

ブール値

いいえ

false

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

  • true

  • false (デフォルト)

segmentCount

数値

いいえ

1

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

segmentIndex

数値

いいえ

0

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

レスポンスヘッダー

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

レスポンス要素

名前

データ型

説明

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": "CAESCG15aC2-xxxxx",
   "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"
         }
      }
   ]
}

エラーコード

エラーコード

HTTP ステータスコード

説明

VectorIndexParameterInvalid

400

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

MalformedJson

400

リクエストボディの JSON フォーマットは無効です。

AccessDenied

403

このエラーの原因として、次のものが考えられます:

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

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

NoSuchVectorIndex

404

指定されたベクターインデックスは存在しません。

QpsLimitExceeded

503

クエリ/秒 (QPS) に基づくリクエストのレート制限。