Referensi API ListVectorIndexes - Object Storage Service - Alibaba Cloud - Object Storage Service

Menampilkan semua vector index dalam sebuah vector bucket.

Catatan penggunaan

Operasi ListVectorIndexes mengembalikan maksimal 500 index per panggilan. Untuk mengambil halaman hasil berikutnya, gunakan token pagination dari respons saat ini.

Izin

Akun Alibaba Cloud memiliki izin penuh untuk mengakses semua operasi API. Secara default, Pengguna RAM dan Peran RAM tidak dapat memanggil operasi ini. Anda harus membuat dan menyambungkan Kebijakan RAM atau kebijakan bucket untuk memberikan izin yang diperlukan.

API	Action	Deskripsi
ListVectorIndexes	`oss:ListVectorIndexes`	Menampilkan vector index.

Sintaksis permintaan

POST /?listVectorIndexes HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.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 Header HTTP umum.

Parameter permintaan

Parameter	Tipe	Wajib	Contoh	Deskripsi
maxResults	Integer	Tidak	100	Jumlah maksimum index yang akan dikembalikan. Nilai yang valid: 0 hingga 500. Jika parameter ini tidak ditentukan atau diatur ke 0, nilai default-nya adalah 100.
nextToken	String	Tidak	myindex1	Token pagination yang digunakan untuk mengambil halaman hasil berikutnya. Untuk melanjutkan penayangan daftar, atur parameter ini ke nilai `nextToken` dari respons sebelumnya.
prefix	String	Tidak	my	Memfilter hasil agar hanya mencakup index yang namanya diawali dengan awalan ini.

Header respons

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

Elemen respons

Parameter	Tipe	Contoh	Deskripsi
indexes	Array of objects	-	Kontainer untuk vector index.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Nama sumber daya (ARN) dari vector bucket tempat index tersebut berada, dalam format acs:ossvector:{region}:{accountId}:{bucketName}. Node induk: index
indexName	String	vectorindex1	Nama vector index. node induk: `index`
createTime	String	2025-04-17T10:56:21.000Z	Waktu pembuatan vector index, dalam UTC. node induk: `index`
dataType	String	float32	Tipe data vektor. node induk: `index`
dimension	Integer	1024	Dimensi vektor. node induk: `index`
distanceMetric	String	euclidean	Metriks jarak. node induk: `index`
metadata	Container	-	Konfigurasi metadata. node induk: `index`
nonFilterableMetadataKeys	Array of strings	["category", "timestamp"]	Daftar bidang metadata yang tidak dapat digunakan untuk filtering. node induk: `metadata`
status	String	enable	Status vector index. Nilai yang valid: `creating` `enable` `deleting`
mode	String	fusion	Mode index. Nilai yang valid: standard (Standard mode) fusion (Fusion mode) node induk: `index`
nextToken	String	myindex1	Token pagination. Jika respons terpotong, gunakan token ini pada permintaan berikutnya untuk mengambil lebih banyak hasil.

Catatan

Elemen respons di atas dikembalikan untuk index dalam mode Standard. Index mode Standard dan Fusion dapat berada dalam satu vector bucket yang sama, dan daftar yang dikembalikan mencakup kedua jenis index tersebut, yang dapat dibedakan melalui bidang mode. Untuk index mode Fusion, hanya informasi dasar seperti bucketArn, indexName, createTime, mode, dan status yang dikembalikan. Untuk mendapatkan konfigurasi skema lengkap dari index mode Fusion, panggil operasi GetVectorIndex.

Contoh

Mode Standard

Contoh permintaan

POST /?listVectorIndexes 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
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": [ 
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T10:56:21.000Z",
         "indexName": "vectorindex1",
         "mode": "standard",
         "dataType": "float32",
         "dimension": 1024,
         "distanceMetric": "euclidean",
         "metadata": { 
             "nonFilterableMetadataKeys": ["category", "timestamp"]
          },
         "status": "enable"
      },
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T11:20:15.000Z",
         "indexName": "vectorindex2",
         "mode": "standard",
         "dataType": "float32",
         "dimension": 512,
         "distanceMetric": "cosine",
         "metadata": { 
             "nonFilterableMetadataKeys": ["type", "source"]
          },
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

Mode Fusion

Contoh permintaan

POST /?listVectorIndexes 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
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": [ 
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T10:56:21.000Z",
         "indexName": "vectorindex1",
         "mode": "standard",
         "dataType": "float32",
         "dimension": 1024,
         "distanceMetric": "euclidean",
         "metadata": { 
             "nonFilterableMetadataKeys": ["category", "timestamp"]
          },
         "status": "enable"
      },
      { 
         "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
         "createTime": "2025-04-17T11:20:15.000Z",
         "indexName": "vectorindex2",
         "mode": "fusion",
         "status": "enable"
      }
   ],
   "nextToken": "myindex1"
}

SDK

Panggil operasi ini menggunakan SDK berikut:

CLI ossutil

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

Kode error

Kode error	Kode status HTTP	Deskripsi
VectorIndexParameterInvalid	400	Parameter vector index yang diberikan dalam permintaan tidak valid.
MalformedJson	400	Badan permintaan tidak dalam format JSON yang valid.
AccessDenied	403	Akses ditolak. Kemungkinan penyebab: Permintaan tidak menyertakan informasi autentikasi yang diperlukan. Anda tidak memiliki izin yang diperlukan untuk melakukan operasi ini.