HappyOyster-Acting-暂停Travel API参考-大模型服务平台百炼(Model Studio)-阿里云帮助中心

请求暂停正在运行的 Acting Travel。暂停后视频生成停止，可通过恢复Travel接口继续。

适用范围

请求暂停正在运行的 Acting Travel。调用前请确认以下事项：

鉴权要求：不强制主 API Key，主 API Key 或临时 API Key 均可调用。获取方式请参见获取鉴权凭证。
前置条件：Travel 状态需为 running。可通过查询Travel状态接口确认。
调用方：您的服务端或客户端均可调用。

HTTP调用

新加坡

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

调用时请将{WorkspaceId}替换为真实的Workspace ID。

美国（弗吉尼亚）

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

调用时请将{WorkspaceId}替换为真实的Workspace ID。

请求参数

暂停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（必选）

请求内容类型。此参数必须设置为application/json。

Authorization string （必选）

API Key 鉴权。不强制主 API Key，主 API Key 或临时 API Key 均可调用。

主 API Key：以 sk- 开头，如 sk-xxx。
临时 API Key：以 st- 开头，如 st-xxx。

请求体（Request Body）

encryptedTravelId string （必选）

要暂停的 Acting 加密 Travel ID。由客户端进入房间接口返回。

userAgent string （可选）

SDK 或客户端版本标识。非空字符串，优先于 HTTP User-Agent，用于 SDK 版本和平台统计。

响应参数

暂停成功

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

code integer

返回码。0 表示成功，非 0 为错误码。

message string

错误信息。成功时为 null。

data object

响应数据。失败时为 null。

属性

encryptedTravelId string

加密的 Travel ID。

status string

暂停目标状态，返回 paused。

前置状态与调用注意事项

Travel 当前状态必须为 running。
进房响应中的 version 必须为 actingV2；Acting 进房固定返回该值。
暂停确认是异步过程。收到成功响应后，如果需要立即恢复或发送依赖暂停态的操作，应继续轮询查询Travel状态，直到查询状态为 paused。
暂停确认通常存在约 3 秒的状态屏障，实际状态以查询结果为准。
暂停不改变 aspectRatio，客户端继续保持进房时确定的播放器方向。

错误码

如果模型调用失败并返回报错信息，请参见HappyOyster 错误码进行解决。

下一步

暂停后可进行以下操作：

恢复Travel：恢复已暂停的 Travel 继续生成。
发送文本过程指令：在 paused 状态发送指令只会接受指令，不会自动恢复。
结束Travel：直接结束 Travel。