Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Query Travel List

Lakukan paginasi pada Travel Acting di bawah akun utama saat ini, dengan pemfilteran opsional berdasarkan status atau World yang terkait.

Cakupan

Lakukan paginasi pada Travel Acting di bawah akun utama saat ini, dengan pemfilteran opsional berdasarkan status atau World yang terkait. Sebelum memanggil, konfirmasikan hal berikut:
  • Autentikasi: Hanya API Key utama yang didukung; API Key sementara tidak dapat digunakan (kode kesalahan 403003).
  • Pemanggil: Dipanggil oleh server Anda.

Permintaan HTTP

  • Singapore
  • AS (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travelsGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Kueri daftar Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels?page=1&pageSize=20&status=completed&encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
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 Travel. Nilai yang tidak dikenal tidak diterapkan sebagai filter. Nilai yang diizinkan:
  • init: menginisialisasi sumber daya sesi
  • pending: dalam antrean atau menunggu sumber daya layanan
  • running: berjalan
  • failed: Travel gagal; lihat errorCode / errorMessage untuk mengetahui alasannya
  • completed: Travel telah berakhir; artifacts dapat dikueri
encryptedWorldId string (Opsional)ID World Acting di bawah akun utama saat ini. Jika disediakan, hanya Travel dari World tersebut yang akan dikembalikan. Endpoint ini tidak mendukung parameter kueri mode; entri khusus model secara otomatis membatasi hasil hanya pada Acting.

Parameter respons

  • Kueri berhasil
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 3,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 180,
                "createdAt": "2026-09-09T08:10:00Z",
                "endedAt": "2026-09-09T08:13:00Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "running",
                "mode": 3,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-09-09T09:10:00Z",
                "endedAt": null
            },
            {
                "encryptedTravelId": "trvl_m3n4****",
                "status": "failed",
                "mode": 3,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-09-09T10:10:00Z",
                "endedAt": "2026-09-09T10:10:05Z",
                "errorCode": "TRAVEL_SESSION_INIT_FAILED",
                "errorMessage": "Failed to allocate inference resources."
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 3,
            "hasMore": false
        }
    }
}
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 arrayDaftar Travel pada halaman saat ini; berupa array kosong jika tidak ada hasil. Setiap item berisi encryptedTravelId, status, mode (selalu 3), encryptedWorldId, durationSec (bernilai null saat berjalan, gagal, atau durasi belum tersedia), createdAt, dan endedAt (bernilai null jika masih berjalan); item dengan status=failed juga menyertakan errorCode (alasan kegagalan terstruktur; lihat Query Travel Status untuk mengetahui nilainya) dan errorMessage (deskripsi dalam bahasa Inggris); item dengan status lain tidak menyertakan kedua kunci ini.pagination objectInformasi paginasi. Berisi page, pageSize, total, dan hasMore.

Status prasyarat dan catatan pemanggilan

  • Endpoint ini secara otomatis hanya mengembalikan Travel Acting, dan items[].mode selalu bernilai 3.
  • Saat memfilter dengan encryptedWorldId, World tersebut harus berada di bawah akun utama saat ini dan menggunakan model Acting; World dari model lain akan mengembalikan 403001.
  • Untuk Travel yang sedang berjalan, durationSec dan endedAt biasanya bernilai null.
  • Item dengan status failed juga menyertakan errorCode / errorMessage; item dengan status lain tidak menyertakan kedua kunci ini. Saat menampilkan alasan kegagalan dalam daftar riwayat, lakukan percabangan berdasarkan errorCode.
  • Nilai status yang tidak dikenal tidak memicu error; nilai tersebut dianggap sebagai tanpa filter status. Untuk mengkueri status paused real-time dari satu Travel, gunakan Query Travel Status.
  • 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

Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
  • Pembuatan audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model