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

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace do DataWorks. Você pode clicar no ícone Gerenciar Workspace no canto superior direito da página do DataStudio para acessar a página de Gerenciamento de Workspace e visualizar o ID do workspace.	10000
ProjectIdentifier	string	Não	O GUID do workspace do DataWorks. Você pode visualizar o GUID na parte superior da página do DataStudio. Você também pode selecionar outro GUID para alternar para outro workspace. Você deve especificar este parâmetro ou o parâmetro ProjectId para determinar o workspace 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 erros 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	The status of the deployment task. Valid values: 0, 1, and 2. A value of 0 indicates that the task is ready. A value of 1 indicates that the task was successful. A value of 2 indicates that the task failed.	1
ErrorMessage	string	The error message that was returned when the deployment package failed. In this case, the value of the Status parameter is 2.	Success
FromEnvironment	integer	The environment in which the deployment task was run. Valid values: 0 and 1. A value of 0 indicates the on-premises environment. A value of 1 indicates the development environment.	0
ToEnvironment	integer	The environment to which the file was deployed. Valid values: 1 and 2. A value of 1 indicates the development environment. A value of 2 indicates the production environment.	1
CheckingStatus	integer	The check status of one or more files in the deployment task. If the value of the ToEnvironment parameter is 1, the files can be deployed to the production environment only when the value of the Status parameter is 1 and the CheckingStatus parameter is empty. Valid values: 7: The file failed the check. 8: The file is being checked.	7
CreateTime	integer	The time when the deployment task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593877765000
HandlerId	string	The ID of the Alibaba Cloud account used by the user who ran the deployment task.	2003****
CreatorId	string	The ID of the Alibaba Cloud account used by the user who created the deployment task.	20030****
ExecuteTime	integer	The time when the deployment task was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593877765000
Name	string	The name of the deployment task. The value is the same as the name of the specific deployment task that is displayed on the Release Package page in the Deploy module.	ods_user_info_d-2020-07-04_20030****
DeployedItems	array<object>	Os itens implantados.
	object	Os detalhes do item implantado.
FileId	integer	The file ID.	5076****
FileVersion	integer	The version of the file.	7
Status	integer	UNPUBLISHED(0): not published SUCCESS(1): Published ERROR(2): Publishing failed CLONED(3): successfully CLONED DEPLOY_ERROR(4): Publishing failed CLONING(5): CLONING REJECT(6): release rejected	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	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.