現在のプライマリアカウント配下のDirectingワールドを削除します。同じアカウント配下にワールドが存在しなくなった場合、冪等にdeleted=falseを返します。
スコープ
現在のプライマリアカウント配下のDirectingワールドを削除します。呼び出す前に、以下を確認してください。
-
認証:プライマリ API Key のみがサポートされています。一時的な API Key は使用できません(エラーコード
403003)。- プライマリ API Key を取得する:API Key の取得と設定。
-
前提条件:Create World によって返された
encryptedWorldIdを使用して削除します。 -
呼び出し元:お使いのサーバーから呼び出されます。このエンドポイントはリクエストボディフィールド
userAgentを受け付けません。
HTTP リクエスト
Singapore
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/delete
{WorkspaceId} を実際の ワークスペースID に置き換えます。
米国(バージニア)
POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/delete
{WorkspaceId} を実際の ワークスペースID に置き換えます。
リクエストパラメーター | Delete World |
Content-Type リクエストのコンテンツタイプ。このパラメータは | |
Authorization API Key 認証。プライマリ API Key のみがサポートされており、 | |
リクエストボディ | |
encryptedWorldId 削除対象のDirecting暗号化ワールドIDです。ワールドの作成によって返されます。 |
レスポンスパラメーター | 正常に削除されましたWorld は既に存在しません |
code リターンコード。 | |
message エラーメッセージ。成功時は | |
data レスポンスデータ。失敗時は |
前提条件となるステータスと呼び出しに関する注意事項
- 同じアカウントの下に World が存在しなくなった場合、
403001ではなくcode=0とdeleted=falseが返されます。 - IDが解析可能であってもアカウントを跨ぐ場合、ワークスペースと一致しない場合、またはリソースがDirectingワールドではない場合は、
403001が返されます。 - 削除後、このワールドへの後続のクエリは存在しないまたは削除済みのリソースとして処理されます。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
- ワールドリストの照会:残りのDirectingワールドを表示します。
- ワールドの作成:新しいDirectingワールドを作成します。