Skip to main content

HappyOyster-Adventure-刪除World API參考

刪除目前主帳號名下的 Adventure World。同帳號下 World 已不存在時冪等返回 deleted=false。

適用範圍

刪除目前主帳號名下的 Adventure World。呼叫前請確認以下事項：
  • 驗證要求：僅支援 主 API Key 呼叫，臨時 API Key 無法使用（錯誤碼 403003）。
  • 前置條件：使用建立World介面返回的 encryptedWorldId 刪除。
  • 呼叫方：由您的伺服器端呼叫。本介面不接受請求主體欄位 userAgent。

HTTP 呼叫

  • 新加坡
  • 华北2（北京）
  • 美国（維吉尼亞）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/delete呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

請求參數

  • 刪除 World
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/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。
請求主體（Request Body）
encryptedWorldId string （必選）要刪除的 Adventure 加密 World ID。由建立World介面返回。

回應參數

  • 刪除成功
  • World 已不存在
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}
code integer返回碼。0 表示成功，非 0 為錯誤碼。
message string錯誤訊息。成功時為 null。
data object回應資料。失敗時為 null。

屬性

encryptedWorldId string請求中的加密 World ID。deleted booleantrue 表示已刪除；false 表示本次未刪除到 World。

前置狀態與呼叫注意事項

  • 當同帳號下的 World 已不存在時，返回 code=0 且 deleted=false，不會返回 403001。
  • ID 可解析但跨帳號、workspace 不匹配或資源不是 Adventure World 時，返回 403001。
  • 刪除後若繼續呼叫詳情、建構狀態或換取憑證，將視為資源不存在處理。

錯誤碼

如果模型呼叫失敗並返回錯誤訊息，請參閱 HappyOyster 錯誤碼進行解決。

下一步