主动结束 Adventure Travel。正常结束后进入 completed;无推流超时结束时进入 failed,且不生成回放产物。达到 maxExperienceTimeSec 时服务端也会自动结束。
适用范围
主动结束 Adventure Travel。正常结束后 Travel 进入 completed;无推流超时结束时进入 failed。调用前请确认以下事项:
- 鉴权要求:不强制主 API Key,主 API Key 或临时 API Key 均可调用。获取方式请参见获取鉴权凭证。
- 前置条件:Travel 必须尚未进入终态,并处于服务端可结束的状态。可通过查询Travel状态接口确认。
- 调用方:您的服务端或客户端均可调用。
HTTP调用
新加坡
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end
调用时请将{WorkspaceId}替换为真实的Workspace ID。
华北2(北京)
POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end
调用时请将{WorkspaceId}替换为真实的Workspace ID。
美国(弗吉尼亚)
POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end
调用时请将{WorkspaceId}替换为真实的Workspace ID。
请求参数 | 正常结束无推流超时结束 |
Content-Type 请求内容类型。此参数必须设置为 | |
Authorization API Key 鉴权。不强制主 API Key,主 API Key 或临时 API Key 均可调用。
| |
请求体(Request Body) | |
encryptedTravelId 要结束的 Adventure 加密 Travel ID。由客户端进入房间接口返回。 | |
failCode 无推流超时的失败结束原因。省略时按正常结束处理。当前仅支持:
传入未支持的值返回 | |
userAgent SDK 或客户端版本标识。非空字符串,优先于 HTTP |
响应参数 | 正常结束无推流超时结束 |
code 返回码。 | |
message 错误信息。成功时为 | |
data 响应数据。失败时为 |
前置状态与调用注意事项
encryptedTravelId必须属于当前主账号和 Adventure 模型。failCode省略时按正常结束处理;传入未支持的值返回400000。- 达到
maxExperienceTimeSec后服务端会自动结束 Travel;客户端应以状态回调或状态查询结果收敛本地状态。 - 正常结束的
durationSec优先使用可用成片的实际时长;成片时长尚不可解析时可能为null。 - 正常结束为
completed后,合成产物仍可能继续处理,应按查询Travel产物查询并轮询。
错误码
如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。
下一步
Travel 进入 completed 后:
- 查询Travel产物:轮询获取录制原片和合成变体。
- 查询Travel列表:查看历史 Travel。