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

Consulta as informações sobre 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

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

get

*全部资源

*

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 clicar no ícone Gerenciar Espaço de Trabalho no canto superior direito da página do Data Studio para acessar a página de Gerenciamento de Espaço de Trabalho e visualizar o ID do espaço de trabalho.	10000
ProjectIdentifier	string	Não	O identificador exclusivo em inglês do espaço de trabalho do DataWorks, exibido no seletor de espaços de trabalho na parte superior da página do Data Studio. Você deve especificar este parâmetro ou o parâmetro ProjectId para determinar o espaço de trabalho do DataWorks ao qual a operação é aplicada.	dw_project
DeploymentId	integer	Sim	O ID da tarefa de implantação. Um ID de tarefa de implantação é gerado quando você chama a operação SubmitFile ou DeployFile.	3000001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
HttpStatusCode	integer	O código de status HTTP retornado.	200
ErrorMessage	string	A mensagem de erro retornada.	The connection does not exist.
RequestId	string	O ID da solicitação. Você pode solucionar problemas com base no ID.	0000-ABCD-EFG****
ErrorCode	string	O código de erro retornado.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	Os detalhes do pacote de implantação.
Deployment	object	Os detalhes do pacote de implantação.
Status	integer	O status da tarefa de implantação. Valores válidos: 0, 1 e 2. O valor 0 indica que a tarefa está pronta. O valor 1 indica que a tarefa foi bem-sucedida. O valor 2 indica que a tarefa falhou.	1
ErrorMessage	string	A mensagem de erro que foi retornada quando o pacote de implantação falhou. Nesse caso, o valor do parâmetro Status é 2.	Success
FromEnvironment	integer	O ambiente no qual a tarefa de implantação foi executada. Valores válidos: 0 e 1. O valor 0 indica o ambiente local. O valor 1 indica o ambiente de desenvolvimento.	0
ToEnvironment	integer	O ambiente para o qual o arquivo foi implantado. Valores válidos: 1 e 2. O valor 1 indica o ambiente de desenvolvimento. O valor 2 indica o ambiente de produção.	1
CheckingStatus	integer	O status de verificação de um ou mais arquivos na tarefa de implantação. Se o valor do parâmetro ToEnvironment for 1, os arquivos poderão ser implantados no ambiente de produção somente quando o valor do parâmetro Status for 1 e o parâmetro CheckingStatus estiver vazio. Valores válidos: 7: O arquivo falhou na verificação. 8: O arquivo está sendo verificado.	7
CreateTime	integer	A hora em que a tarefa de implantação foi criada. Este valor é um carimbo de data e hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1593877765000
HandlerId	string	O ID da conta Alibaba Cloud usada pelo usuário que executou a tarefa de implantação.	2003****
CreatorId	string	O ID da conta Alibaba Cloud usada pelo usuário que criou a tarefa de implantação.	20030****
ExecuteTime	integer	A hora em que a tarefa de implantação foi executada. Este valor é um carimbo de data e hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1593877765000
Name	string	O nome da tarefa de implantação. O valor é o mesmo que o nome da tarefa de implantação específica exibido na página Pacote de Lançamento no módulo Implantação.	ods_user_info_d-2020-07-04_20030****
DeployedItems	array<object>	Os itens implantados.
	object	Os detalhes do item implantado.
FileId	integer	O ID do arquivo.	5076****
FileVersion	integer	A versão do arquivo.	7
Status	integer	UNPUBLISHED(0): não publicado SUCCESS(1): Publicado ERROR(2): Falha na publicação CLONED(3): CLONADO com sucesso DEPLOY_ERROR(4): Falha na publicação CLONING(5): CLONANDO REJECT(6): release rejeitado	1

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "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
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.