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

Descrição da operação

Esta é uma operação assíncrona. Uma chamada bem-sucedida retorna um ID de implantação. Use este ID com a operação GetDeployment para consultar o status de execução e o resultado final da tarefa de implantação.

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:*

update

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o ID do espaço de trabalho. Você deve definir este parâmetro ou o parâmetro ProjectIdentifier para especificar o espaço de trabalho do DataWorks para a chamada de API.	10000
ProjectIdentifier	string	Não	O nome do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o nome do espaço de trabalho. Você deve definir este parâmetro ou o parâmetro ProjectId para especificar o espaço de trabalho do DataWorks para esta chamada de API.	dw_project
FileId	integer	Não	O ID do arquivo. Você pode chamar a operação ListFiles para obter este ID. Você só precisa especificar este parâmetro ou o parâmetro NodeId.	10000022
Comment	string	Não	A descrição desta implantação.	First release task
NodeId	integer	Não	O ID da tarefa no sistema de agendamento para o arquivo a ser implantado. Você só precisa especificar este parâmetro ou o parâmetro FileId.	2000001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Estrutura de dados retornada.
HttpStatusCode	integer	O código de status HTTP.	200
Data	integer	O ID do pacote de implantação. Você pode então usar este ID como um parâmetro ao chamar a API GetDeployment para obter os detalhes da implantação.	30000001
RequestId	string	O ID da solicitação é usado para solucionar problemas quando ocorre um erro.	0000-ABCD-EFG****
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
Success	boolean	Indica se a chamada foi bem-sucedida.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "Data": 30000001,
  "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
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.
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.