Skip to main content

HappyOyster-Acting-Resume Travel API リファレンス

一時停止中の Acting Travel を再開し、実行状態に戻します。

スコープ

一時停止中の Acting Travel を再開し、実行状態に戻します。呼び出し前に、以下を確認してください。
  • 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
  • 前提条件：Travel は Query Travel Status を通じて paused であることが確認されている必要があります。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

  • Singapore
  • 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • Travel の再開
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume' \
    -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 キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
  • プライマリ API Key：sk- で始まります（例：sk-xxx）。
  • 一時 API キー：st- で始まり、例は st-xxx です。
リクエストボディ
encryptedTravelId string （必須）再開対象の Acting 暗号化 Travel ID です。Travel への入室 によって返されます。
userAgent string （任意）SDKまたはクライアントのバージョン識別子。空ではない文字列で、HTTP User-Agentよりも優先され、SDKバージョンおよびプラットフォーム統計に使用されます。

レスポンスパラメーター

  • 再開成功
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running"
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string暗号化されたTravel ID。status string再開後のステータス。running を返します。

前提条件となるステータスと呼び出しに関する注意事項

  • Travel は Query Travel Status を通じて paused であることが確認されている必要があります。
  • 入室レスポンスの version は actingV2 である必要があります。
  • すでに終了または失敗したTravelは再開できません。
  • 再開後、テキスト処理指示 の送信を継続できます。クライアントは、ステータス照会結果に基づいてローカルの実行状態を収束させる必要があります。
  • 再開しても、入室時に返される aspectRatio は変更されません。

エラーコード

モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。

次のステップ

再開後、以下の操作を実行できます。