Skip to main content

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

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

Scope

Paginer les Travels Acting sous le compte principal actuel, avec un filtrage facultatif par statut ou par World associé. Avant d'effectuer l'appel, 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
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/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-acting/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é ; voir errorCode / errorMessage pour la raison
  • completed : le Travel est terminé ; les artefacts peuvent être interrogés
encryptedWorldId string (Facultatif)Un ID de World Acting sous le compte principal actuel. Lorsqu'il est fourni, seuls les Travels de ce World sont renvoyé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 à Acting.

Paramètres de réponse

  • Requête réussie
{
    "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 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 3), encryptedWorldId, durationSec (null lorsqu'il est en cours d'exécution, en échec ou que la durée n'est pas encore disponible), createdAt et endedAt (null lorsqu'il est toujours en cours d'exécution) ; les éléments avec status=failed portent également errorCode (raison d'échec structurée ; voir Query Travel Status pour les valeurs) et errorMessage (description en anglais) ; les éléments dans d'autres statuts n'incluent pas ces deux clés.pagination objectInformations de pagination. Contient page, pageSize, total et hasMore.

États préalables et notes d'appel

  • Le point de terminaison renvoie automatiquement uniquement les Travels Acting, et items[].mode est toujours 3.
  • Lors du filtrage avec encryptedWorldId, ce World doit appartenir au compte principal actuel et au modèle Acting ; un World provenant d'un autre modèle renvoie 403001.
  • Pour un Travel en cours d'exécution, durationSec et endedAt sont généralement null.
  • Les éléments failed portent également errorCode / errorMessage ; les éléments dans d'autres statuts n'incluent pas ces deux clés. Lors de l'affichage de la raison de l'échec dans les listes historiques, effectuez une branche sur errorCode.
  • Une valeur status inconnue ne déclenche pas d'erreur ; elle est traitée comme une absence de filtre de statut. Pour interroger le statut paused en temps réel d'un seul Travel, utilisez Query Travel Status.
  • 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