Skip to main content

Referência da API HappyOyster-Directing-Delete World

Exclua um Mundo de Direção na conta principal atual. Quando o Mundo não existe mais na mesma conta, ele retorna deleted=false de forma idempotente.

Escopo

Exclua um Mundo de Direção na conta principal atual. Antes de chamar, confirme o seguinte:
  • Autenticação: Apenas a API Key primária é suportada; API Keys temporárias não podem ser usadas (código de erro 403003).
  • Pré-requisitos: Exclua com o encryptedWorldId retornado por Criar Mundo.
  • Chamador: Chamado pelo seu servidor. Este endpoint não aceita o campo do corpo da solicitação userAgent.

Solicitação HTTP

  • Singapore
  • EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/deleteSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Excluir 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(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json.
Authorization string (Obrigatório)Autenticação por API Key. Apenas a API Key primária é suportada; ela começa com sk-, ex. sk-xxx. É tipicamente configurada como a variável de ambiente $DASHSCOPE_API_KEY. Uma API Key temporária (começando com st-) retorna 403003.
Corpo da solicitação
encryptedWorldId string (Obrigatório)O ID de Mundo criptografado de Direção a ser excluído. Retornado por Criar Mundo.

Parâmetros de resposta

  • Excluído com sucesso
  • O Mundo não existe mais
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "deleted": true
    }
}
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro.
message stringMensagem de erro. null em caso de sucesso.
data objectDados da resposta. null em caso de falha.

Propriedades

encryptedWorldId stringO ID do Mundo criptografado da solicitação.deleted booleantrue significa que foi excluído; false significa que nenhum Mundo foi excluído desta vez.

Estados pré-requisitos e notas de chamada

  • Quando o Mundo não existir mais sob a mesma conta, ele retorna code=0 e deleted=false, não 403001.
  • Quando o ID é analisável, mas pertence a outra conta, não corresponde ao workspace ou o recurso não é um Mundo de Direção, 403001 é retornado.
  • Após a exclusão, as consultas subsequentes a este Mundo são tratadas como um recurso inexistente ou excluído.

Códigos de erro

Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.

Próximos passos