Melakukan kueri terhadap metadata lengkap dan parameter pembuatan yang dapat digemakan dari satu Adventure World. Untuk polling progres pembangunan, gunakan endpoint Query World Build Status.
Cakupan
Melakukan kueri terhadap metadata lengkap dan parameter pembuatan yang dapat digemakan dari satu Adventure World. 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.
-
Prasyarat: Lakukan kueri dengan
encryptedWorldIdyang dikembalikan oleh Create World. Untuk polling progres pembangunan, gunakan Query World Build Status. - 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/worlds/detailGanti {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 | |
encryptedWorldId string (Wajib)ID World terenkripsi Adventure di bawah akun utama saat ini. Dikembalikan oleh Create World. |
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 encryptedWorldId stringID World terenkripsi.name stringNama World.status stringStatus pembangunan: generating / ready / failed.mode integerSelalu 1 untuk Adventure.creationModel stringSelalu simple untuk Adventure.prompt stringPrompt tingkat atas yang dikirimkan saat pembuatan.eventStyle nullAdventure tidak menggunakan parameter pembuatan ini; biasanya null. Bidang ini hanya berlaku untuk Directing creationModel=simple.perspective stringPerspektif: first_person / third_person.uploadMode stringDitetapkan ke first_frame.resolution nullAdventure tidak menggunakan bidang ini; biasanya null.aspectRatio nullAdventure tidak menggunakan bidang ini; ditetapkan ke null.layout nullAdventure tidak menggunakan bidang ini; biasanya null.narrative nullAdventure tidak menggunakan bidang ini; biasanya null.refWorldId stringID World referensi terenkripsi yang digunakan untuk pembuatan turunan; null jika none.firstFrameImage objectGambar frame pertama yang wajib ada saat pembuatan; dikembalikan dalam bentuk URL saja. Berisi url dan referenceType.inputImages nullAdventure saat ini tidak menggunakan bidang ini.scriptList nullAdventure tidak mendukung ScriptList; ditetapkan ke null.previewUrl nullSaat ini ditetapkan ke null.createdAt stringWaktu pembuatan, dalam format ISO 8601.updatedAt stringWaktu pembaruan terakhir, dalam format ISO 8601. |
Status prasyarat dan catatan pemanggilan
- Endpoint ini dapat mengkueri World
generating,ready, ataufailed; beberapa artefak pembangunan mungkin bernilainullsebelum siap. - Endpoint detail tidak menggemakan
async, karena ini adalah pengalih perilaku panggilan, bukan atribut World. - Gambar hanya dikembalikan sebagai URL dan
referenceType; konten base64 dalam permintaan pembuatan tidak dikembalikan. - Melakukan kueri terhadap World dari model lain, akun utama lain, atau World yang telah dihapus akan selalu mengembalikan
403001, tanpa mengungkapkan apakah sumber daya tersebut ada atau tidak.
Kode kesalahan
Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.
Langkah selanjutnya
- Query World List: melakukan paginasi pada semua Adventure Worlds.
- Delete World: hapus World yang tidak lagi Anda gunakan.
- Ketika World berstatus
ready, Anda dapat Get Travel Credential.