GetVectorIndex 操作を呼び出して、ベクターインデックスの詳細を取得します。
権限
Alibaba Cloud アカウントは、デフォルトですべての権限を持ちます。対照的に、Resource Access Management (RAM) ユーザーおよび RAM ロールは、デフォルトでは権限を持ちません。Alibaba Cloud アカウントのオーナーまたは管理者は、RAM ポリシーまたはバケットポリシーを使用して権限を付与する必要があります。
API | Action | 説明 |
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 | コンテナー | N/A | メタデータ構成。 親ノード: 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"
}
}エラーコード
エラーコード | HTTP ステータスコード | 説明 |
VectorIndexParameterInvalid | 400 | リクエストで指定されたベクターインデックスパラメーターは無効です。 |
MalformedJson | 400 | リクエストボディの JSON フォーマットは無効です。 |
AccessDenied | 403 | このエラーは、次の考えられる理由で返されます:
|
NoSuchVectorIndex | 404 | 指定されたベクターインデックスは存在しません。 |