Terminer activement un Travel Adventure. Après une fin normale, il passe à completed ; lors d'une fin par expiration de délai sans flux, il passe à failed et aucun artefact de relecture n'est généré. Le serveur le termine également automatiquement lorsque maxExperienceTimeSec est atteint.
Scope
Terminer activement un Travel Adventure. Après une fin normale, le Travel passe à completed ; lors d'une fin par expiration de délai sans flux, il passe à failed. Avant d'appeler, confirmez les points suivants :
- Authentification : La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler. Pour savoir comment les obtenir, voir Obtenir les identifiants d'authentification.
- Prérequis : Le Travel ne doit pas encore avoir atteint un état terminal et doit se trouver dans un état que le serveur peut terminer. Confirmez via Interroger l'état du Travel.
- Appelant : Votre serveur ou votre client peut l'appeler.
Requête HTTP
- Singapore
- Chine (Pékin)
- États-Unis (Virginie)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/endRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.Paramètres de la requête |
|
Content-Typestring(Requis)Type de contenu de la requête. Ce paramètre doit être défini sur application/json. | |
Authorization string (Requis)Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler.
| |
Corps de la requête | |
encryptedTravelId string (Obligatoire)L'ID chiffré du Travel Adventure à terminer. Retourné par Entrer dans le Travel. | |
failCode string (Facultatif)La raison de fin d'échec pour un délai d'attente sans flux. Lorsqu'elle est omise, cela est traité comme une fin normale. Actuellement pris en charge uniquement :
400000. | |
userAgent string (Facultatif)Identifiant de version du SDK ou du client. Une chaîne non vide ; prévaut sur le User-Agent HTTP. |
Paramètres de réponse |
|
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 encryptedTravelId stringL'ID de Voyage chiffré qui a été terminé.status stringÉtat de fin :
stringCode de raison de l'échec ; null lors d'une fin normale.errorMessage stringDescription de l'échec ; null lors d'une fin normale.endedAt stringHeure de fin, au format ISO 8601.durationSec integerDurée effective de la vidéo en secondes ; null lors d'une fin d'échec sans flux ou lorsque la durée ne peut pas encore être analysée. |
États préalables et notes d'appel
- Le
encryptedTravelIddoit appartenir au compte principal actuel et au modèle Adventure. - Lorsque
failCodeest omis, cela est traité comme une fin normale ; transmettre une valeur non prise en charge retourne400000. - Le serveur termine automatiquement le Travel une fois
maxExperienceTimeSecatteint ; le client doit faire converger son état local à partir des rappels de statut ou des résultats d'interrogation de statut. - Lors d'une fin normale,
durationSecutilise de préférence la durée réelle de la vidéo finale disponible ; elle peut êtrenulllorsque la durée de la vidéo finale ne peut pas encore être analysée. - Après qu'une fin normale atteint
completed, les artefacts composés peuvent encore être en cours de traitement ; interrogez-les et surveillez-les selon Interroger les artefacts du Travel.
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
Une fois que le Voyage est passé à l'état completed :
- Interroger les artefacts du Travel : interroger régulièrement pour obtenir les variantes originales enregistrées et composées.
- Interroger la liste des Travels : consulter les Travels historiques.