GetVectorIndex - Object Storage Service

Panggil operasi GetVectorIndex untuk mengambil detail mengenai indeks vektor.

Izin

Secara default, akun Alibaba Cloud memiliki izin penuh. Pengguna Resource Access Management (RAM) dan Peran RAM di bawah akun Alibaba Cloud tidak memiliki izin secara default. Akun Alibaba Cloud atau administrator akun harus memberikan izin menggunakan kebijakan RAM atau kebijakan bucket.

API	Action	Deskripsi
GetVectorIndex	`oss:GetVectorIndex`	Mendapatkan informasi indeks vektor.

Sintaksis permintaan

POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
{
   "indexName": "string"
}

Header permintaan

Operasi ini hanya menggunakan header permintaan umum. Untuk informasi selengkapnya, lihat Header HTTP umum.

Parameter permintaan

Nama	Tipe Data	Wajib	Contoh	Deskripsi
indexName	String	Ya	vectorindex1	Nama indeks.

Header respons

Operasi ini hanya menggunakan header respons umum. Untuk informasi selengkapnya, lihat Header HTTP umum.

Elemen respons

Nama	Tipe	Contoh	Deskripsi
index	Kontainer	-	Kontainer yang menyimpan informasi indeks vektor.
indexName	String	vectorindex1	Nama indeks. Node induk: index
createTime	String	2025-04-17T10:56:21.000Z	Waktu pembuatan indeks dalam format GMT. Node induk: index
dataType	String	float32	Tipe data vektor. Node induk: index
dimension	Integer	1024	Dimensi vektor. Node induk: index
distanceMetric	String	euclidean	Fungsi pengukuran jarak. Node induk: index
metadata	Kontainer	-	Konfigurasi metadata. Node induk: index
nonFilterableMetadataKeys	Array of strings	["category", "timestamp"]	Daftar bidang metadata yang tidak dapat difilter. Node induk: metadata
status	String	enable	Status saat ini dari indeks. Nilai yang valid: creating Enabled (active) deleting

Contoh

Permintaan contoh

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"
}

Respons contoh

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 berikut mendukung operasi GetVectorIndex:

Alat baris perintah ossutil

Untuk perintah ossutil yang sesuai dengan operasi GetVectorIndex, lihat get-vector-index.

Kode error

Kode error	Kode status HTTP	Deskripsi
VectorIndexParameterInvalid	400	Parameter indeks vektor dalam permintaan tidak valid.
MalformedJson	400	Format JSON dalam badan permintaan tidak valid.
AccessDenied	403	Kemungkinan penyebab: Anda tidak menyertakan informasi autentikasi dalam permintaan. Anda tidak memiliki izin yang diperlukan.
NoSuchVectorIndex	404	Indeks vektor yang ditentukan tidak ada.