Référence de l'API HappyOyster-Directing-Pause Travel - Alibaba Cloud Model Studio

Demander la mise en pause d'un voyage de mise en scène en cours. Une fois la pause terminée, vous pouvez appeler reprendre ou rembobiner.

Scope

Demander la mise en pause d'un voyage de mise en scène en cours. Une fois la pause terminée, vous pouvez appeler reprendre ou rembobiner. Avant d'effectuer l'appel, confirmer 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-directing/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-directing/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-directing/openapi/v1/travels/pause' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/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'ID de voyage chiffré de mise en scène à mettre en pause. Retourné par Entrer dans le voyage.

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

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 en salle doit être storyV2 ; l'entrée en salle pour ce modèle retourne toujours cette valeur.
La confirmation du statut de pause côté serveur est un processus asynchrone. Lorsque vous devez appeler immédiatement rembobiner ou reprendre, interrogez Interroger le statut du voyage jusqu'à ce que le statut soit paused.

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 :

Reprendre le voyage : reprendre un voyage mis en pause et continuer l'exécution.
Rembobiner le voyage : revenir à un horodatage vidéo spécifié.
End Travel : terminer directement le voyage.