全部產品
Search

搜尋本產品

    Alibaba Cloud Model Studio：HappyOyster-Directing-暫停Travel API參考

    文件中心

    Alibaba Cloud Model Studio：HappyOyster-Directing-暫停Travel API參考

    更新時間：Sep 23, 2026

    請求暫停正在運行的 Directing Travel。暫停完成後可呼叫恢復或回溯。

    適用範圍

    請求暫停正在運行的 Directing 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-directing/openapi/v1/travels/pause

    呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

    美国（維吉尼亞）

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

    呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

    請求參數

    暫停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（必選）

    請求內容類型。此參數必須設定為 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 （必選）

    要暫停的 Directing 加密 Travel ID。由用戶端進入房間介面返回。

    userAgent string （可選）

    SDK 或用戶端版本識別碼。非空字串，優先於 HTTP User-Agent。

    回應參數

    暫停成功

    {
    "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 必須為 storyV2；本模型進房固定返回該值。
    • pause 的伺服器狀態確認是非同步過程。需要緊接著呼叫回溯或恢復時，應輪詢查詢Travel狀態直到狀態為 paused。

    錯誤碼

    如果模型呼叫失敗並返回錯誤訊息，請參閱 HappyOyster 錯誤碼進行解決。

    下一步

    暫停後可進行以下操作：