Melakukan paginasi pada Adventure Worlds di bawah akun utama saat ini. Endpoint ini secara otomatis diisolasi berdasarkan model dan tidak pernah mengembalikan Directing atau Acting Worlds.
Cakupan
Melakukan paginasi pada Adventure Worlds di bawah akun utama saat ini. Sebelum memanggil, pastikan hal berikut:
-
Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan
403003).- Dapatkan API Key utama: Mendapatkan dan mengonfigurasi API Key.
- Pemanggil: Dipanggil oleh server Anda.
Permintaan HTTP
- Singapore
- Tiongkok (Beijing)
- AS (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worldsGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.Parameter permintaan |
|
Authorization string (Wajib)Autentikasi API Key. Hanya API Key utama yang didukung; dimulai dengan sk-, misalnya sk-xxx. Biasanya dikonfigurasi sebagai variabel lingkungan $DASHSCOPE_API_KEY. API Key sementara (dimulai dengan st-) akan mengembalikan 403003. | |
Parameter kueri | |
page integer (Opsional)Nomor halaman, defaultnya 1. Jika page <= 0, nilainya dianggap sebagai 1. | |
pageSize integer (Opsional)Jumlah item per halaman, defaultnya 20. Jika pageSize <= 0, nilainya dianggap sebagai 20; jika lebih besar dari 100, nilainya dibatasi hingga 100. | |
status string (Opsional)Filter berdasarkan status pembangunan. Nilai yang tidak dikenal tidak diterapkan sebagai filter. Nilai yang diizinkan:
| |
mode integer (Opsional)Tidak perlu meneruskan parameter ini. Daftar sudah difilter ke model Adventure, dan items[].mode selalu bernilai 1. Jika Anda tetap meneruskannya dan nilainya bukan 1, maka 400000 akan dikembalikan. |
Parameter respons |
|
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan. | |
message stringPesan kesalahan. null jika berhasil. | |
data objectData respons. null jika gagal.
Properti items arrayWorlds pada halaman saat ini; berupa array kosong jika tidak ada hasil. Setiap item berisi encryptedWorldId, name, status (generating / ready / failed), mode (selalu 1), previewUrl (biasanya null), createdAt, perspective (first_person / third_person), creationModel (selalu simple), dan uploadMode (ditetapkan ke first_frame).pagination objectInformasi paginasi. Berisi page, pageSize, total, dan hasMore (true ketika page × pageSize < total). |
Status prasyarat dan catatan pemanggilan
- Item daftar merupakan snapshot ringan; item tersebut tidak mengembalikan gambar, prompt,
refWorldId, atau parameter pembuatan lengkap lainnya. Ketika Anda memerlukan konfigurasi lengkap, panggil Query World Detail. statusyang tidak dikenal tidak menimbulkan kesalahan; hal ini diperlakukan sebagai tanpa filter status.- Saat melakukan paging, gunakan
pagination.pageSizedanhasMoredari respons; jangan berasumsi bahwa nilai yang diminta diadopsi secara harfiah. - Hasil kosong bukanlah kesalahan; respons akan mengembalikan
items=[]beserta informasi paginasi yang sesuai.
Kode kesalahan
Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.
Langkah selanjutnya
- Query World Detail: lihat metadata lengkap dari satu World.
- Delete World: hapus World yang tidak lagi Anda gunakan.