Referensi API ListVectorIndexes - Object Storage Service

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

Catatan penting

ListVectorIndexes mengembalikan hingga 500 indeks per panggilan. Gunakan pagination untuk mengambil batch indeks berikutnya.
Konkurensi maksimum untuk ListVectorIndexes adalah 16.

Izin

Secara default, Akun Alibaba Cloud memiliki izin penuh. Namun, Pengguna RAM dan Peran RAM tidak memiliki izin apa pun. Akun Alibaba Cloud atau administrator harus memberikan izin melalui RAM policy atau bucket policy.

API	Action	Description
ListVectorIndexes	`oss:ListVectorIndexes`	List vector indexes.

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 selengkapnya, lihat Common HTTP headers.

Parameter permintaan

Name	Data Types	Required	Example	Description
maxResults	value	No	100	Jumlah maksimum indeks yang akan dikembalikan. Nilai yang valid: 0 hingga 500. Jika Anda tidak menentukan parameter ini atau mengaturnya ke 0, nilai default-nya adalah 100.
nextToken	String	No	myindex1	Mulai mengembalikan hasil dari indeks pertama yang muncul secara alfabetis setelah nextToken.
prefix	String	No	my	Cocokkan indeks vektor berdasarkan awalan.

Header respons

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

Elemen respons

Name	Type	Example value	Description
indexes	Array of objects	-	Array yang berisi informasi indeks vektor.
indexName	String	vectorindex1	Nama indeks. Parent node: index
createTime	String	2025-04-17T10:56:21.000Z	Waktu saat indeks dibuat, dalam format GMT. Parent node: index
dataType	String	float32	Tipe data vektor. Parent node: index
dimension	Integer	1024	Dimensi vektor. Parent node: index
distanceMetric	String	euclidean	Fungsi metrik jarak. Parent node: index
metadata	Container	-	Konfigurasi metadata. Parent node: index
nonFilterableMetadataKeys	Array of strings	["category", "timestamp"]	Daftar bidang metadata yang tidak dapat difilter. Parent node: metadata
status	String	enable	Status saat ini dari indeks. Nilai yang valid: creating enable deleting
nextToken	String	myindex1	Token pagination untuk halaman berikutnya. Jika panggilan ini tidak mengembalikan semua hasil, respons akan menyertakan nextToken untuk kueri berikutnya.

Contoh

Permintaan contoh

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

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

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

SDK

SDK untuk ListVectorIndexes:

Perintah ossutil

Untuk perintah ossutil yang sesuai dengan ListVectorIndexes, lihat list-vector-indexes.

Kode kesalahan

Error code	HTTP status code	Description
VectorIndexParameterInvalid	400	Parameter indeks vektor dalam permintaan tidak valid.
MalformedJson	400	Format JSON dalam badan permintaan tidak valid.
AccessDenied	403	Kemungkinan penyebab: Permintaan tidak menyertakan informasi autentikasi. Anda tidak memiliki izin untuk melakukan operasi ini.