GetVectorIndex - Object Storage Service

Panggil operasi GetVectorIndex untuk mendapatkan detail indeks vektor.

Izin

Akun Alibaba Cloud memiliki semua izin secara default. Sebaliknya, Pengguna Manajemen Akses Sumber Daya (RAM) dan Peran RAM tidak memiliki izin apa pun secara default. Pemilik Akun Alibaba Cloud atau administrator harus memberikan izin menggunakan Kebijakan RAM atau Kebijakan Bucket.

API	Action	Deskripsi
GetVectorIndex	`oss:GetVectorIndex`	Mendapatkan informasi tentang 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 lebih lanjut, lihat Header HTTP Umum.

Parameter permintaan

Nama	Tipe data	Diperlukan	Contoh	Deskripsi
indexName	String	Ya	vectorindex1	Nama indeks.

Header respons

Operasi ini hanya menggunakan header respons umum. Untuk informasi lebih lanjut, lihat Header HTTP Umum.

Elemen respons

Nama	Tipe data	Contoh	Deskripsi
index	Kontainer	-	Kontainer untuk informasi indeks vektor.
indexName	String	vectorindex1	Nama indeks. Node induk: index
createTime	String	2025-04-17T10:56:21.000Z	Waktu pembuatan indeks. Waktu dalam format GMT. Node induk: index
dataType	String	float32	Tipe data dari vektor. Node induk: index
dimension	Integer	1.024	Dimensi vektor. Node induk: index
distanceMetric	String	euclidean	Fungsi ukuran jarak. Node induk: index
metadata	Kontainer	N/A	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 valid: creating enable deleting

Contoh

Contoh permintaan

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

Contoh respons

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

Kode kesalahan

Kode kesalahan	Kode status HTTP	Deskripsi
VectorIndexParameterInvalid	400	Parameter indeks vektor yang diberikan dalam permintaan tidak valid.
MalformedJson	400	Format JSON dari badan permintaan tidak valid.
AccessDenied	403	Kesalahan ini dikembalikan karena alasan berikut: Informasi autentikasi pengguna tidak disertakan dalam permintaan. Anda tidak memiliki izin yang diperlukan.
NoSuchVectorIndex	404	Indeks vektor yang ditentukan tidak ada.