HappyOyster-Acting-Pause Travel API Reference - Alibaba Cloud Model Studio

Demander la mise en pause d'un voyage Acting en cours d'exécution. Après la mise en pause, la génération vidéo s'arrête et vous pouvez continuer via le point de terminaison Resume Travel.

Scope

Demander la mise en pause d'un voyage Acting en cours d'exécution. 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 statut du voyage doit être running. Confirmez via Query Travel Status.
Appelant : Votre serveur ou votre client peut l'appeler.

Requête HTTP

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

Pause Travel

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/1.2.0"
}'

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.

Clé API principale : commence par sk-, par ex. sk-xxx.
Clé API temporaire : commence par st-, par exemple st-xxx.

Corps de la requête

encryptedTravelId string (Obligatoire)

L'identifiant de voyage Acting chiffré à mettre en pause. Retourné par Enter Travel.

userAgent string (Facultatif)

Identifiant de version du SDK ou du client. Une chaîne non vide ; prévaut sur le User-Agent HTTP, utilisé pour les statistiques de version du SDK et de plateforme.

Paramètres de réponse

Mise en pause réussie

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "paused"
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedTravelId string

L'identifiant de voyage chiffré.

status string

Le statut cible de la pause ; retourne paused.

États préalables et notes d'appel

Le statut actuel du voyage doit être running.
Le version dans la réponse d'entrée dans la salle doit être actingV2 ; l'entrée dans la salle pour Acting retourne toujours cette valeur.
La confirmation de la pause est un processus asynchrone. Après avoir reçu une réponse de succès, si vous devez reprendre immédiatement ou envoyer une opération dépendant de l'état de pause, continuez à interroger Query Travel Status jusqu'à ce que l'état interrogé soit paused.
La confirmation de la mise en pause comporte généralement un délai de statut d'environ 3 secondes ; le statut réel dépend du résultat de la requête.
La mise en pause ne modifie pas aspectRatio ; le client conserve l'orientation du lecteur déterminée au moment de l'entrée dans la salle.

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

Après la mise en pause, vous pouvez effectuer les actions suivantes :

Resume Travel : reprendre un voyage en pause et continuer la génération.
Send Process Instruction : l'envoi d'une instruction dans l'état paused accepte uniquement l'instruction et ne reprend pas automatiquement.
End Travel : terminer directement le voyage.