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

Obtém os detalhes de um processo de implantação.

Descrição da operação

Importante

Para versões anteriores do SDK que não incluem esta API, use a API GetDeployment com os mesmos parâmetros descritos neste documento.

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	Sim	O ID do workspace do DataWorks. Você pode encontrar esse ID na página Gerenciamento de Workspaces no console do DataWorks. Este parâmetro especifica o workspace do DataWorks para a chamada de API.	10000
Id	string	Sim	O identificador exclusivo do pipeline de publicação.	a7ef0634-20ec-4a7c-a214-54020f****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas.	08468352-032C-5262-AEDC-68C9FA05XXXX
Pipeline	object	Os detalhes da execução do pipeline.
Id	string	O ID da execução do pipeline.	a7ef0634-20ec-4a7c-a214-54020f91XXXX
ProjectId	integer	O ID do workspace do DataWorks.	56160
CreateTime	integer	A hora em que a execução do pipeline foi criada. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1724984066000
ModifyTime	integer	A hora em que a execução do pipeline foi modificada pela última vez. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1724984066000
Creator	string	O ID do usuário que criou a execução do pipeline.	137946317766XXXX
Status	string	O status da execução do pipeline. Valores válidos: `Init`: A execução do pipeline está sendo inicializada. `Running`: A execução do pipeline está em andamento. `Success`: A execução do pipeline foi bem-sucedida. `Fail`: A execução do pipeline falhou. `Terminated`: A execução do pipeline foi encerrada. `Canceled`: A execução do pipeline foi cancelada.	Running
Message	string	A mensagem de erro retornada se a execução do pipeline falhar.	Error message
Stages	array<object>	Os estágios na execução do pipeline.
	array<object>	Os detalhes de um estágio.
Code	string	The code that identifies the stage.	DEV_CHECK
Step	integer	The sequence number of the stage within the pipeline.	1
Type	string	The type of the stage. Valid values: `Deploy`: A deployment operation. `Check`: A check operation. `Offline`: An offline operation. `Build`: A build operation. `Delete`: A delete operation. Valores válidos: Delete : Build : Check : Offline : Deploy :	Check
Name	string	The name of the stage.	Publish package build
Description	string	The description of the stage.	Phase description
Message	string	The exception message returned if the stage fails.	Exception information XXX
Status	string	The status of the stage. Valid values: `Init`: The stage is being initialized. `Running`: The stage is in progress. `Success`: The stage succeeded. `Fail`: The stage failed. `Terminated`: The stage was terminated. `Canceled`: The stage was canceled. Valores válidos: Init : Cancel : Running : Termination : Success : Fail :	Running
Detail	object	Detailed information about the stage.
	any	Additional key-value pairs that provide more information about the stage.	"checkerList": [ { "code": "BuildPackageChecker", "name": "Build_Package_Checker" }, { "code": "NodeParentDependency", "name": "Downstream_Dependency_Checker" }, { "code": "NodeInProcess", "name": "Decommissioning_Process_Checker" } ]
Description	string	The description of the pipeline run.	发布流程描述信息

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "08468352-032C-5262-AEDC-68C9FA05XXXX",
  "Pipeline": {
    "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n",
    "ProjectId": 56160,
    "CreateTime": 1724984066000,
    "ModifyTime": 1724984066000,
    "Creator": "137946317766XXXX",
    "Status": "Running",
    "Message": "Error message",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "Publish package build",
        "Description": "Phase description",
        "Message": "Exception information XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n    {\n        \"code\": \"BuildPackageChecker\",\n        \"name\": \"Build_Package_Checker\"\n    },\n    {\n        \"code\": \"NodeParentDependency\",\n        \"name\": \"Downstream_Dependency_Checker\"\n    },\n    {\n        \"code\": \"NodeInProcess\",\n        \"name\": \"Decommissioning_Process_Checker\"\n    }\n]\n"
        }
      }
    ],
    "Description": "发布流程描述信息"
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.