GetVectorIndex - OSS ベクトルインデックス API - Object Storage Service

権限

Alibaba Cloud アカウントはデフォルトで全ての権限を持ちますが、RAM ユーザーと RAM ロールには、RAM ポリシーまたはバケットポリシーを使用して明示的に権限を付与する必要があります。

API	Action	説明
GetVectorIndex	`oss:GetVectorIndex`	ベクトルインデックス情報を取得します。

リクエスト構文

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

{
   "indexName": "string"
}

リクエストヘッダー

この API では、共通リクエストヘッダーのみを使用します。

リクエストパラメーター

名前	データ型	必須	例	説明
indexName	string	はい	my-vector-index	インデックスの名前。

レスポンスヘッダー

この API では、共通レスポンスヘッダーのみを使用します。

レスポンス要素

名前	データ型	例	説明
index	コンテナ	-	ベクトルインデックス情報のコンテナ。
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	インデックスが属するベクトルバケットのリソース名 (ARN) です。形式は `acs:ossvector:{region}:{accountId}:{bucketName}` です。親ノード： index
indexName	string	my-vector-index	インデックスの名前。親ノード： index
createTime	string	2025-04-17T10:56:21.000Z	インデックスが作成された日時です。日時は GMT 形式です。親ノード： index
dataType	string	float32	ベクトルデータ型。親ノード： index
dimension	Integer	1024	ベクトル次元の数。親ノード： index
distanceMetric	string	euclidean	距離メトリック関数。親ノード： index
metadata	コンテナ	-	メタデータ構成。親ノード： index
nonFilterableMetadataKeys	string array	["category", "timestamp"]	フィルター不可のメタデータフィールド。親ノード： metadata
status	string	active	インデックスのステータス。有効な値は次のとおりです： creating active deleting

例

リクエスト例

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

{
   "indexName": "my-vector-index"
}

レスポンス例

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

{
   "index": { 
      "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
      "createTime": "2025-04-17T10:56:21.000Z",
      "indexName": "my-vector-index",
      "dataType": "float32",
      "dimension": 1024,
      "distanceMetric": "euclidean",
      "metadata": { 
         "nonFilterableMetadataKeys": ["category", "timestamp"]
      },
      "status": "active"
   }
}

SDK

GetVectorIndex で使用可能な SDK:

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

ossutil get-vector-index を使用して、コマンドラインから GetVectorIndex を実行します。

エラーコード

エラーコード	HTTP ステータスコード	説明
VectorIndexParameterInvalid	400	リクエストに無効なベクトルインデックスパラメーターが含まれています。
MalformedJson	400	リクエスト本文に無効な JSON が含まれています。
AccessDenied	403	考えられる原因：リクエストに認証情報が含まれていません。権限が不足しています。
NoSuchVectorIndex	404	ベクトルインデックスが存在しません。