Referencia de la API HappyOyster-Acting-Pause Travel - Alibaba Cloud Model Studio

Solicitud para pausar un viaje Acting en ejecución. Después de la pausa, la generación de video se detiene y puede continuar mediante el endpoint Resume Travel.

Ámbito

Solicitud para pausar un viaje Acting en ejecución. Antes de realizar la llamada, confirme lo siguiente:

Autenticación: La clave de API principal no es obligatoria; pueden invocarla tanto la clave principal como una temporal. Para saber cómo obtenerlas, consulte Obtener credenciales de autenticación.
Prerequisites: El estado del viaje debe ser running. Confírmelo mediante Query Travel Status.
Solicitante: Puede invocarla su servidor o su cliente.

Solicitud HTTP

Singapore

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

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

EE. UU. (Virginia)

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

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

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(Requerido)

Tipo de contenido de la solicitud. Este parámetro debe establecerse en application/json.

Authorization string (Requerido)

Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal.

Clave de API principal: comienza con sk-, por ejemplo, sk-xxx.
Clave de API temporal: comienza con st-, por ejemplo, st-xxx.

Cuerpo de la solicitud

encryptedTravelId string (Obligatorio)

El ID de viaje cifrado de Acting a pausar. Devuelto por Enter Travel.

userAgent string (Opcional)

Identificador de versión del SDK o cliente. Una cadena no vacía; tiene prioridad sobre el User-Agent HTTP, utilizado para estadísticas de versión del SDK y plataforma.

Parámetros de respuesta

Pausa exitosa

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

code integer

Código de retorno. 0 indica éxito; un valor distinto de cero es un código de error.

message string

Mensaje de error. null en caso de éxito.

data object

Datos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId string

El ID de viaje cifrado.

status string

El estado de pausa objetivo; devuelve paused.

Estados previos y notas de llamada

El estado actual del viaje debe ser running.
El version en la respuesta de entrada a la sala debe ser actingV2; entrar en la sala para Acting siempre devuelve este valor.
La confirmación de pausa es un proceso asíncrono. Después de recibir una respuesta exitosa, si necesita reanudar inmediatamente o enviar una operación que dependa del estado de pausa, continúe sondeando Query Travel Status hasta que el estado consultado sea paused.
La confirmación de pausa suele tener una barrera de estado de aproximadamente 3 segundos; el estado real está sujeto al resultado de la consulta.
Pausar no cambia aspectRatio; el cliente mantiene la orientación del reproductor determinada en el momento de entrar en la sala.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Después de pausar, puede realizar lo siguiente:

Resume Travel: reanudar un viaje pausado y continuar la generación.
Send Process Instruction: enviar una instrucción en el estado paused solo acepta la instrucción y no reanuda automáticamente.
End Travel: finalizar el viaje directamente.