Skip to main content

Référence de l'API HappyOyster-Adventure-Query Travel List

Paginer les Adventure Travels sous le compte principal actuel, avec un filtrage optionnel par statut ou par World associé.

Scope

Paginer à travers les Travels Adventure sous le compte principal actuel, avec un filtrage optionnel par statut ou par Monde associé. Avant d'appeler, confirmez les points suivants :
  • Authentification : Seule la clé API principale est prise en charge ; les clés API temporaires ne peuvent pas être utilisées (code d'erreur 403003).
  • Appelant : Appelé par votre serveur.

Requête HTTP

  • Singapore
  • Chine (Pékin)
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travelsRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

  • Interroger la liste des Travels
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels?page=1&pageSize=20&status=completed&encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (Requis)Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par sk-, par ex. sk-xxx. Elle est généralement configurée comme variable d'environnement $DASHSCOPE_API_KEY. Une clé API temporaire (commençant par st-) renvoie 403003.
Paramètres de requête
page integer (Facultatif)Numéro de page, par défaut 1. Lorsque page <= 0, il est traité comme 1.
pageSize integer (Facultatif)Éléments par page, par défaut 20. Lorsque pageSize <= 0, il est traité comme 20 ; lorsqu'il est supérieur à 100, il est plafonné à 100.
status string (Facultatif)Filtrer par statut de Travel. Les valeurs inconnues ne sont pas appliquées comme filtre. Valeurs autorisées :
  • init : initialisation des ressources de session
  • pending : en file d'attente ou en attente de ressources de service
  • running : en cours d'exécution
  • failed : le Travel a échoué
  • completed : le Travel est terminé ; les artefacts peuvent être interrogés
encryptedWorldId string (Facultatif)Un ID de Monde Adventure sous le compte principal actuel. Lorsqu'il est fourni, seuls les Travels de ce Monde sont retournés. Ce point de terminaison ne prend pas en charge le paramètre de requête mode ; l'entrée spécifique au modèle limite automatiquement les résultats à Adventure.

Paramètres de réponse

  • Requête réussie
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 1,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 90,
                "createdAt": "2026-06-03T10:00:00Z",
                "endedAt": "2026-06-03T10:01:30Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "running",
                "mode": 1,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-06-03T11:00:00Z",
                "endedAt": null
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.
message stringMessage d'erreur. null en cas de succès.
data objectDonnées de réponse. null en cas d'échec.

Propriétés

items arrayLes Travels sur la page actuelle ; un tableau vide lorsqu'il n'y a aucun résultat. Chaque élément contient encryptedTravelId, status, mode (toujours 1), encryptedWorldId, durationSec (null lorsque running, failed, ou que la durée n'est pas encore disponible), createdAt, et endedAt (null lorsque toujours en cours d'exécution).pagination objectInformations de pagination. Contient page, pageSize, total et hasMore.

États préalables et notes d'appel

  • Le point de terminaison retourne automatiquement uniquement les Travels Adventure, et items[].mode est toujours 1.
  • Lors du filtrage avec encryptedWorldId, ce Monde doit appartenir au compte principal actuel et au modèle Adventure ; un Monde provenant d'un autre modèle retourne 403001.
  • Pour un Travel en cours d'exécution, durationSec et endedAt sont généralement null.
  • Un status inconnu ne déclenche pas d'erreur ; il est traité comme une absence de filtre de statut.
  • Un résultat vide n'est pas une erreur ; il renvoie items=[] et les informations de pagination correspondantes.

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes