GetVectorIndex 操作を呼び出して、ベクターインデックスの詳細情報を取得します。
権限
デフォルトでは、Alibaba Cloud アカウントはフルアクセス権限を持ちます。Alibaba Cloud アカウント配下の Resource Access Management (RAM) ユーザーおよび RAM ロールは、デフォルトで権限を持っていません。Alibaba Cloud アカウントまたはアカウント管理者が、RAM ポリシー または バケットポリシー を使用して権限を付与する必要があります。
API | アクション | 説明 |
GetVectorIndex |
| ベクターインデックス情報を取得します。 |
リクエスト構文
POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
{
"indexName": "string"
}リクエストヘッダー
この操作では共通のリクエストヘッダーのみを使用します。詳細については、「共通 HTTP ヘッダー」をご参照ください。
リクエストパラメーター
名前 | データの型 | 必須 | 例 | 説明 |
indexName | 文字列 | はい | vectorindex1 | インデックス名。 |
応答ヘッダー
この操作では共通の応答ヘッダーのみを使用します。詳細については、「共通 HTTP ヘッダー」をご参照ください。
応答要素
名前 | データの型 | 例 | 説明 |
index | コンテナー | - | ベクターインデックス情報を格納するコンテナー。 |
indexName | 文字列 | vectorindex1 | インデックスの名前。 親ノード：index |
createTime | 文字列 | 2025-04-17T10:56:21.000Z | インデックス作成時刻（GMT 形式）。 親ノード：index |
dataType | 文字列 | float32 | ベクトルデータの型。 親ノード：index |
dimension | 整数 | 1024 | ベクターディメンション。 親ノード：index |
distanceMetric | 文字列 | euclidean | 距離測定関数。 親ノード：index |
metadata | コンテナー | - | メタデータ構成。 親ノード：index |
nonFilterableMetadataKeys | 文字列の配列 | ["category", "timestamp"] | フィルター不可なメタデータフィールドのリスト。 親ノード：metadata |
status | 文字列 | enable | インデックスの現在のステータス。有効値：
|
例
リクエスト例
POST /?getVectorIndex 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
{
"indexName": "vectorindex1"
}応答例
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": {
"createTime": "2025-04-17T10:56:21.000Z",
"dataType": "float32",
"dimension": 1024,
"distanceMetric": "euclidean",
"metadata": {
"nonFilterableMetadataKeys": ["category", "timestamp"]
},
"status": "enable"
}
}SDK
以下の SDK は GetVectorIndex 操作をサポートしています。
ossutil コマンドラインツール
GetVectorIndex 操作に対応する ossutil コマンドについては、「get-vector-index」をご参照ください。
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
VectorIndexParameterInvalid | 400 | リクエスト内のベクターインデックスパラメーターが無効です。 |
MalformedJson | 400 | リクエストボディの JSON 形式が無効です。 |
AccessDenied | 403 | 考えられる原因：
|
NoSuchVectorIndex | 404 | 指定されたベクターインデックスが存在しません。 |