Panggil operasi GetVectorIndex untuk mengambil detail indeks vektor.
Izin
Akun Alibaba Cloud memiliki semua izin secara default. Namun, Pengguna Resource Access Management (RAM) atau Peran RAM tidak memiliki izin secara default. Anda harus memberikan izin kepada Pengguna RAM atau Peran RAM menggunakan Ikhtisar Kebijakan RAM atau Kebijakan Bucket.
|
API |
Action |
Deskripsi |
|
GetVectorIndex |
|
Mendapatkan informasi tentang indeks vektor. |
Sintaksis permintaan
POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.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 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 saat indeks dibuat. Waktu 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 metrik jarak. Node induk: index |
|
metadata |
Kontainer |
- |
Konfigurasi metadata. Node induk: index |
|
nonFilterableMetadataKeys |
larik string |
["category", "timestamp"] |
Daftar bidang metadata yang tidak dapat difilter. Node induk: metadata |
|
status |
string |
enable |
Status saat ini dari indeks. Nilai yang valid:
|
Contoh
Contoh permintaan
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": "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"
}
}SDK
SDK berikut tersedia untuk memanggil operasi GetVectorIndex:
Antarmuka baris perintah ossutil
Untuk informasi selengkapnya tentang perintah ossutil untuk operasi GetVectorIndex, lihat get-vector-index.
Kode kesalahan
|
Kode kesalahan |
Kode status HTTP |
Deskripsi |
|
VectorIndexParameterInvalid |
400 |
Parameter indeks vektor yang diberikan dalam permintaan tidak valid. |
|
MalformedJson |
400 |
Format JSON pada badan permintaan tidak valid. |
|
AccessDenied |
403 |
Kesalahan ini dikembalikan karena alasan berikut:
|
|
NoSuchVectorIndex |
404 |
Indeks vektor yang ditentukan tidak ada. |