Skip to main content

Referencia de la API de HappyOyster-Directing-Delete World

Elimina un Mundo de Dirección bajo la cuenta principal actual. Cuando el Mundo ya no existe bajo la misma cuenta, devuelve deleted=false de manera idempotente.

Ámbito

Elimina un Mundo de Dirección bajo la cuenta principal actual. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: Solo se admite la API Key principal; no se pueden utilizar API Keys temporales (código de error 403003).
  • Requisitos previos: Eliminar con el encryptedWorldId devuelto por Crear Mundo.
  • Solicitante: Llamado por su servidor. Este endpoint no acepta el campo del cuerpo de solicitud userAgent.

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/deleteReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Eliminar mundo
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-Typestring(Requerido)Tipo de contenido de la solicitud. Este parámetro debe establecerse en application/json.
Authorization string (Requerido)Autenticación mediante API Key. Solo se admite la API Key principal; comienza con sk-, p. ej., sk-xxx. Normalmente se configura como la variable de entorno $DASHSCOPE_API_KEY. Una API Key temporal (que comienza con st-) devuelve 403003.
Cuerpo de la solicitud
encryptedWorldId string (Requerido)El ID de Mundo cifrado de Dirección que se va a eliminar. Devuelto por Crear Mundo.

Parámetros de respuesta

  • Eliminado correctamente
  • El mundo ya no existe
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedWorldId stringEl ID de mundo cifrado de la solicitud.deleted booleantrue significa que fue eliminado; false significa que no se eliminó ningún mundo esta vez.

Estados previos y notas de llamada

  • Cuando el mundo ya no existe bajo la misma cuenta, devuelve code=0 y deleted=false, no 403001.
  • Cuando el ID es analizable pero pertenece a otra cuenta, no coincide con el espacio de trabajo o el recurso no es un Mundo de Dirección, se devuelve 403001.
  • Después de la eliminación, las consultas posteriores de este Mundo se gestionan como un recurso inexistente o eliminado.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos