Paginer à travers les Voyages Directing sous le compte principal actuel, avec un filtrage optionnel par statut ou par Monde associé.
Scope
Paginer les voyages de mise en scène sous le compte principal actuel, avec un filtrage optionnel par statut ou par monde associé. Avant d'effectuer l'appel, confirmer 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).- Obtenir la clé API principale : Obtenir et configurer une clé API.
- 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-directing/openapi/v1/travelsRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.Paramètres de la requête |
|
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 :
| |
encryptedWorldId string (Facultatif)Un ID de Monde chiffré Directing sous le compte principal actuel. Lorsqu'il est fourni, seuls les Voyages de ce Monde sont retournés. Ce point de terminaison limite automatiquement les résultats au modèle Directing et ne prend pas en charge le paramètre de requête mode. |
Paramètres de réponse | Query succeeded |
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 Voyages sur la page actuelle ; un tableau vide lorsqu'il n'y a aucun résultat. Chaque élément contient encryptedTravelId, status, mode (toujours 2), encryptedWorldId, durationSec (null lorsque l'exécution est en cours ou que le montage final n'est pas encore prêt), createdAt et endedAt (null lorsque l'exécution est en cours).pagination objectInformations de pagination. Contient page, pageSize, total et hasMore. |
États préalables et notes d'appel
- Le filtre de modèle s'applique automatiquement, et
items[].modeest toujours2. - Lors du filtrage avec
encryptedWorldId, ce monde doit appartenir au compte principal actuel et au modèle de mise en scène ; un ID de monde provenant d'un autre modèle retourne403001. - Pour un voyage en cours,
durationSecetendedAtpeuvent êtrenull. - Un
statusinconnu ne déclenche pas d'erreur ; il est traité comme une absence de filtre de statut. Pour un statut de pause côté serveur, interroger un voyage unique via Interroger le statut du voyage.
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
- Query Travel Status : interroger le statut en temps réel d'un seul Travel.
- Query Travel Artifacts : interroger les artefacts vidéo d'un Travel terminé.