ListVectorIndexes - Object Storage Service

Anda dapat memanggil operasi ListVectorIndexes untuk mencantumkan semua indeks vektor dalam sebuah bucket vektor.

Catatan

Operasi ListVectorIndexes mengembalikan maksimum 500 indeks per panggilan. Gunakan paging untuk mengambil batch berikutnya.
Jumlah maksimum panggilan ListVectorIndexes secara bersamaan adalah 16.

Izin

Akun Alibaba Cloud memiliki semua izin secara default. Secara default, Pengguna Manajemen Akses Sumber Daya (RAM) atau Peran RAM di bawah Akun Alibaba Cloud tidak memiliki izin. Pemilik Akun Alibaba Cloud atau administrator harus memberikan izin menggunakan Kebijakan RAM atau kebijakan bucket.

API	Aksi	Deskripsi
ListVectorIndexes	`oss:ListVectorIndexes`	Mendaftar indeks vektor.

Sintaksis permintaan

POST /?listVectorIndexes HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
Content-type: application/json

{
   "maxResults": int,
   "nextToken": "string",
   "prefix": "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
maxResults	Nomor	Tidak	100	Jumlah maksimum indeks yang akan dikembalikan. Nilai valid: 0 hingga 500. Jika Anda tidak menetapkan parameter ini atau menetapkannya ke 0, nilai default adalah 100.
nextToken	String	Tidak	myindex1	Hasil dimulai dari entri pertama yang datang setelah nextToken dalam urutan abjad.
prefix	String	Tidak	my	Pencocokan awalan untuk indeks vektor.

Header respons

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

Elemen respons

Nama	Tipe data	Contoh	Deskripsi
indeks	Array objek	-	Sebuah array yang berisi informasi tentang indeks vektor.
indexName	String	vectorindex1	Nama indeks. Node induk: index
createTime	String	2025-04-17T10:56:21.000Z	Waktu pembuatan indeks. Waktu dalam 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	Container	-	Konfigurasi metadata. Node induk: index
nonFilterableMetadataKeys	Array string	["kategori", "timestamp"]	Daftar bidang metadata yang tidak dapat difilter. Node induk: metadata
status	String	enable	Status saat ini dari indeks. Nilai valid: Creating Enabled (aktif) deleting: Indeks sedang dihapus.
nextToken	String	myindex1	Token untuk digunakan pada kueri berikutnya. Jika tidak semua hasil dikembalikan dalam panggilan saat ini, token ini disertakan untuk kueri berikutnya.

Contoh

Contoh Permintaan

POST /?listVectorIndexes 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
Content-type: application/json

{
   "maxResults": 10,
   "prefix": "my"
}

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

{
   "indexes": [ 
      { 
         "createTime": "2025-04-17T10:56:21.000Z",
         "indexName": "vectorindex1",
         "dataType": "float32",
         "dimension": 1024,
         "distanceMetric": "euclidean",
         "metadata": { 
             "nonFilterableMetadataKeys": ["category", "timestamp"]
          },
         "status": "enable"
      },
      { 
         "createTime": "2025-04-17T11:20:15.000Z",
         "indexName": "vectorindex2",
         "dataType": "float32",
         "dimension": 512,
         "distanceMetric": "cosine",
         "metadata": { 
             "nonFilterableMetadataKeys": ["type", "source"]
          },
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

Kode kesalahan

Kode kesalahan	Kode status HTTP	Deskripsi
VectorIndexParameterInvalid	400	Parameter indeks vektor dalam permintaan tidak valid.
MalformedJson	400	Format JSON dalam badan permintaan tidak valid.
AccessDenied	403	Penyebab potensial untuk kesalahan ini: Informasi autentikasi pengguna tidak termasuk dalam permintaan. Anda tidak memiliki izin yang diperlukan.