刪除目前主帳號名下的 Acting World。當同帳號下的 World 已不存在時,會以冪等方式返回 deleted=false。
適用範圍
刪除目前主帳號名下的 Acting World。呼叫前請確認下列事項:
-
驗證要求:僅支援 主 API Key 呼叫,臨時 API Key 無法使用(錯誤碼
403003)。- 取得主 API Key:取得與設定 API Key。
-
前置條件:使用建立World介面返回的
encryptedWorldId刪除。 -
呼叫方:由您的伺服器端呼叫。本介面不接受請求主體欄位
userAgent。
HTTP 呼叫
新加坡
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/delete
呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。
美国(維吉尼亞)
POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/delete
呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。
請求參數 | 刪除 World |
Content-Type 請求內容類型。此參數必須設定為 | |
Authorization API Key 驗證。僅支援 主 API Key,以 | |
請求主體(Request Body) | |
encryptedWorldId 要刪除的 Acting 加密 World ID。由 建立 World 介面返回。 |
回應參數 | 刪除成功World 已不存在 |
code 返回碼。 | |
message 錯誤訊息。成功時為 | |
data 回應資料。失敗時為 |
前置狀態與呼叫注意事項
- 當同帳號下的 World 已不存在時,返回
code=0且deleted=false,不會返回403001。 - 當 ID 可解析但跨帳號、workspace 不匹配或資源並非 Acting World 時,返回
403001。 - 刪除後若繼續呼叫詳情、建構狀態或換取憑證,將視為資源不存在處理。
- 已簽發但尚未使用的 ticket 不應被視為長期有效的引用;進房時仍會重新驗證 World 的可用狀態。
錯誤碼
如果模型呼叫失敗並返回錯誤訊息,請參閱 HappyOyster 錯誤碼進行解決。
下一步
- 查詢 World 列表:檢視剩餘的 Acting World。
- 建立 World:建立新的 Acting World。