HappyOyster-Acting-Delete World API リファレンス - Alibaba Cloud Model Studio

現在のプライマリアカウント配下の Acting World を削除します。同じアカウント配下に World が既に存在しない場合、冪等的に deleted=false を返します。

スコープ

現在のプライマリアカウント配下の Acting World を削除します。呼び出す前に、以下を確認してください：

認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。
- プライマリ API Key を取得する：API Key の取得と設定。
前提条件：Create World によって返された encryptedWorldId を使用して削除します。
呼び出し元：お使いのサーバーから呼び出されます。このエンドポイントはリクエストボディフィールド userAgent を受け付けません。

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

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

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

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

リクエストパラメーター	Delete World `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/delete' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "encryptedWorldId": "{encryptedWorldId}" }'`
Content-Type`string`（必須）リクエストのコンテンツタイプ。このパラメータは `application/json` に設定する必要があります。
Authorization `string` （必須） API Key 認証。プライマリ API Key のみがサポートされており、`sk-` で始まります（例：`sk-xxx`）。通常、環境変数 `$DASHSCOPE_API_KEY` として設定されます。一時的な API Key（`st-` で始まる）を使用すると `403003` が返されます。
リクエストボディ
encryptedWorldId `string` （必須）削除対象の Acting 暗号化 World ID。Create World によって返されます。

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": false
    }
}

code integer

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

message string

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

data object

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

プロパティ

encryptedWorldId string

リクエストからの暗号化された World ID。

deleted boolean

true は削除されたことを意味し、false は今回 World が削除されなかったことを意味します。

同じアカウントの下に World が存在しなくなった場合、403001 ではなく code=0 と deleted=false が返されます。
ID が解析可能であっても、アカウントを跨ぐ場合、ワークスペースと一致しない場合、またはリソースが Acting World でない場合は、403001 が返されます。
削除後、後続の詳細、構築ステータス、または Credential 交換の呼び出しは、存在しないリソースとして処理されます。
発行済みだが未使用の ticket を長期間有効な参照として扱うべきではありません。入室時に World の可用性が再検証されます。

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