DeleteFile - DataWorks: Central de Documentação do Alibaba Cloud

Exclui um arquivo do DataStudio. Se o arquivo tiver sido submetido, um processo assíncrono será acionado para excluir o arquivo no sistema de agendamento. O valor do parâmetro DeploymentId retornado é usado para chamar a operação GetDeployment a fim de consultar o status do processo assíncrono.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

delete

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O nome do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página Gerenciamento de Workspaces para visualizar o nome do workspace. Você deve especificar um dos parâmetros ProjectId e ProjectIdentifier para determinar o workspace do DataWorks ao qual a operação é aplicada.	10000
ProjectIdentifier	string	Não	O ID do arquivo. Você pode chamar a operação ListFiles para consultar o ID do arquivo.	dw_project
FileId	integer	Sim	O ID do arquivo. Você pode chamar a operação ListFiles para consultar o ID do arquivo.	10000201

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O ID da tarefa de implantação que implanta o arquivo. Se o arquivo tiver sido submetido, um processo assíncrono será acionado para excluir o arquivo no sistema de agendamento. O valor deste parâmetro é usado para chamar a operação GetDeployment a fim de consultar o status do processo assíncrono. Se este parâmetro estiver vazio, o arquivo será excluído e a consulta não será necessária.	200
DeploymentId	integer	O ID da solicitação. Você pode solucionar problemas com base no ID.	1000000001
RequestId	string	A mensagem de erro retornada.	0000-ABCD-EFG****
ErrorMessage	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	The connection does not exist.
Success	boolean	O código de erro retornado.	true
ErrorCode	string	O ID do arquivo. Você pode usar a interface ListFiles para consultar o ID do arquivo correspondente.	Invalid.Tenant.ConnectionNotExists

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "DeploymentId": 1000000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.