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

Obtém os detalhes de um pacote 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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

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. Este parâmetro especifica o espaço de trabalho do DataWorks para esta chamada de API.	10000
ProjectIdentifier	string	Não	O identificador exclusivo do espaço de trabalho do DataWorks, que é o identificador em inglês exibido na parte superior da página do Data Studio para alternar espaços de trabalho. Você deve especificar este parâmetro ou o ProjectId para determinar o espaço de trabalho do DataWorks para esta chamada de API.	dw_project
DeploymentId	integer	Sim	O ID do pacote de implantação. Um ID de pacote de implantação é gerado quando você chama SubmitFile ou DeployFile.	1000000001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	You have no permission.
RequestId	string	O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas.	0bc1ec92159376****
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.	true
Data	object	Os detalhes do pacote de implantação.
Deployment	object	Os detalhes do pacote de implantação.
Status	integer	O status atual do pacote de implantação. Valores válidos: 0: pronto 1: bem-sucedido 2: com falha	1
ErrorMessage	string	A mensagem de erro registrada quando o pacote de implantação falha ao ser executado (o status é 2).	Success
FromEnvironment	integer	O ambiente a partir do qual a implantação é iniciada. Valores válidos: 0: local 1: ambiente de desenvolvimento	0
ToEnvironment	integer	O ambiente de destino para o qual as informações do arquivo são implantadas. Valores válidos: 1: ambiente de desenvolvimento 2: ambiente de produção	1
CheckingStatus	integer	O status de verificação dos nós envolvidos no pacote de implantação. Quando o ambiente de destino é o ambiente de desenvolvimento (toEnvironment=1), você pode implantar o arquivo no ambiente de produção somente quando o Status do pacote de implantação for 1 e o CheckingStatus estiver vazio. 7: A verificação falhou. 8: A verificação está em andamento.	7
CreateTime	integer	O carimbo de data e hora em que o pacote de implantação foi gerado, em milissegundos.	1593877765000
HandlerId	string	O ID de usuário do Alibaba Cloud do usuário que executou o pacote de implantação.	2003****
CreatorId	string	O ID de usuário do Alibaba Cloud do usuário que criou o pacote de implantação.	20030****
ExecuteTime	integer	O carimbo de data e hora em que o pacote de implantação começou a ser executado, em milissegundos.	1593877765000
Name	string	O nome do pacote de implantação, que é exibido na página Publicação de Tarefas > Lista de Pacotes de Implantação.	ods_user_info_d-2020-07-04_20030****
DeployedItems	array<object>	Os detalhes dos itens implantados.
	object	Os detalhes dos itens implantados.
FileId	integer	O ID do arquivo.	5076****
FileVersion	integer	A versão do arquivo.	7
Status	integer	O status do item implantado. Valores válidos: UNPUBLISHED(0): não implantado SUCCESS(1): implantado com sucesso ERROR(2): falha na implantação CLONED(3): clonado com sucesso DEPLOY_ERROR(4): falha na implantação CLONING(5): clonagem em andamento REJECT(6): implantação rejeitada	1

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission",
  "RequestId": "0bc1ec92159376****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Deployment": {
      "Status": 1,
      "ErrorMessage": "Success",
      "FromEnvironment": 0,
      "ToEnvironment": 1,
      "CheckingStatus": 7,
      "CreateTime": 1593877765000,
      "HandlerId": "2003****",
      "CreatorId": "20030****",
      "ExecuteTime": 1593877765000,
      "Name": "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems": [
      {
        "FileId": 0,
        "FileVersion": 7,
        "Status": 1
      }
    ]
  }
}

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.	Acesso negado. Autorize o acesso.
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.