HappyOyster-Directing-刪除World API參考 - Alibaba Cloud Model Studio

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

適用範圍

刪除目前主帳號名下的 Directing World。呼叫前請確認以下事項：

驗證要求：僅支援 主 API Key 呼叫，臨時 API Key 無法使用（錯誤碼 403003）。
- 取得主 API Key：取得與設定 API Key。
前置條件：使用建立World介面返回的 encryptedWorldId 刪除。
呼叫方：由您的伺服器端呼叫。本介面不接受請求主體欄位 userAgent。

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

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

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

呼叫時請將 {WorkspaceId} 替換為真實的 Workspace ID。

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

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

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

code integer

返回碼。0 表示成功，非 0 為錯誤碼。

message string

錯誤訊息。成功時為 null。

data object

回應資料。失敗時為 null。

屬性

encryptedWorldId string

請求中的加密 World ID。

deleted boolean

true 表示已刪除；false 表示本次未刪除到 World。

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