HappyOyster-Acting-Pause Travel APIリファレンス - Alibaba Cloud Model Studio

実行中のActing Travelの一時停止をリクエストします。一時停止後、ビデオ生成は停止し、Resume Travelエンドポイント経由で続行できます。

スコープ

実行中のActing Travelの一時停止をリクエストします。呼び出す前に、以下を確認してください：

認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得を参照してください。
前提条件：Travelステータスはrunningである必要があります。Query Travel Statusで確認してください。
呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

Singapore

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

{WorkspaceId} を実際のワークスペースID に置き換えます。

米国（バージニア）

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

{WorkspaceId} を実際のワークスペース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 キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。

プライマリ API Key：sk- で始まります（例：sk-xxx）。
一時 API キー：st- で始まり、例は st-xxx です。

リクエストボディ

encryptedTravelId string （必須）

一時停止対象のActing暗号化Travel ID。Enter Travelによって返されます。

userAgent string （任意）

SDKまたはクライアントのバージョン識別子。空ではない文字列で、HTTP User-Agentよりも優先され、SDKバージョンおよびプラットフォーム統計に使用されます。

レスポンスパラメーター

一時停止成功

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

code integer

リターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。

message string

エラーメッセージ。成功時は null です。

data object

レスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string

暗号化されたTravel ID。

status string

ターゲットの一時停止ステータス。pausedを返します。

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

現在のTravelステータスはrunningである必要があります。
入室レスポンスのversionはactingV2である必要があります。Actingの入室時は常にこの値が返されます。
一時停止の確認は非同期プロセスです。成功レスポンスを受信した後、すぐに再開する場合や一時停止状態に依存する操作を送信する必要がある場合は、クエリ結果のステータスがpausedになるまでTravel Statusのクエリのポーリングを継続してください。
一時停止の確認には通常約3秒のステータス障壁があります。実際のステータスはクエリ結果に従います。
一時停止してもaspectRatioは変更されません。クライアントは入室時に決定されたプレイヤーの向きを維持します。

エラーコード

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

次のステップ

一時停止後、以下の操作が可能です：

Resume Travel：一時停止中のTravelを再開し、生成を続行します。
Send Process Instruction：paused状態で指示を送信すると、指示は受理されますが自動的には再開されません。
End Travel：Travelを直接終了します。