Skip to main content
Referensi Open API Directing

Referensi API HappyOyster-Directing-Query Travel List

Melakukan paginasi pada Directing Travel di bawah akun utama saat ini, dengan pemfilteran opsional berdasarkan status atau World terkait.

Cakupan

Lakukan paginasi pada Directing Travel di bawah akun utama saat ini, dengan filter opsional berdasarkan status atau World terkait. Sebelum memanggil, konfirmasi 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-directing/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-directing/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
  • completed: Travel telah berakhir; artifacts dapat dikueri
encryptedWorldId string (Opsional)ID World terenkripsi Directing di bawah akun utama saat ini. Jika disediakan, hanya Travel dari World tersebut yang akan dikembalikan. Endpoint ini secara otomatis membatasi hasil ke model Directing dan tidak mendukung parameter kueri mode.

Parameter respons

Query succeeded
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 2,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 180,
                "createdAt": "2026-06-03T10:00:00Z",
                "endedAt": "2026-06-03T10:03:00Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "completed",
                "mode": 2,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-06-03T11:00:00Z",
                "endedAt": "2026-06-03T11:03:00Z"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "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 arrayTravel pada halaman saat ini; berupa array kosong jika tidak ada hasil. Setiap item berisi encryptedTravelId, status, mode (selalu 2), encryptedWorldId, durationSec (null saat berjalan atau potongan akhir belum siap), createdAt, dan endedAt (null saat berjalan).pagination objectInformasi paginasi. Berisi page, pageSize, total, dan hasMore.

Status prasyarat dan catatan pemanggilan

  • Filter model berlaku secara otomatis, dan items[].mode selalu 2.
  • Saat memfilter dengan encryptedWorldId, World tersebut harus milik akun utama saat ini dan model Directing; ID World dari model lain mengembalikan 403001.
  • Untuk Travel yang sedang berjalan, durationSec dan endedAt dapat bernilai null.
  • status yang tidak dikenal tidak menimbulkan kesalahan; ini diperlakukan sebagai tanpa filter status. Untuk status jeda di sisi server, kueri satu Travel melalui Query Travel Status.

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