Skip to main content

HappyOyster-Acting-Delete World API リファレンス

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

スコープ

現在のプライマリアカウント配下の Acting World を削除します。呼び出す前に、以下を確認してください：
  • 認証：プライマリ API Key のみがサポートされています。一時的な API Key は使用できません（エラーコード 403003）。
  • 前提条件：Create World によって返された encryptedWorldId を使用して削除します。
  • 呼び出し元：お使いのサーバーから呼び出されます。このエンドポイントはリクエストボディフィールド userAgent を受け付けません。

HTTP リクエスト

  • Singapore
  • 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-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-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは 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 によって返されます。

レスポンスパラメーター

  • 正常に削除されました
  • World は既に存在しません
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedWorldId stringリクエストからの暗号化された World ID。deleted booleantrue は削除されたことを意味し、false は今回 World が削除されなかったことを意味します。

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

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

エラーコード

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

次のステップ