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

Obtém uma lista paginada de processos de implantação. Você também pode filtrar essa lista com base em critérios específicos.

Descrição da operação

Importante

Versões anteriores do SDK podem não incluir esta interface. Nesse caso, use a interface ListDeployments. Ela aceita os mesmos parâmetros.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks. Você pode obter esse ID na página Gerenciamento de Espaço de Trabalho no console do DataWorks. Este parâmetro especifica o espaço de trabalho do DataWorks a ser usado para a chamada de API.	10000
Creator	string	Não	Filtra os resultados pelo criador do pipeline.	110755000425****
Status	string	Não	Filtra os resultados pelo status atual do pipeline. Valores válidos: `Init`: inicializando `Running`: em execução `Success`: bem-sucedido `Fail`: com falha `Termination`: encerrado `Cancel`: cancelado.	Running
ObjectId	string	Não	O ID do artefato.	860438872620113XXXX
PageNumber	integer	Não	O número da página. As páginas começam em 1. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação. Use este ID para localizar logs e solucionar problemas.	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que atendem aos critérios de filtro.	2524
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página retornada.	1
PipelineRuns	array<object>	Uma lista de execuções de pipeline de implantação.
	array<object>	Uma execução de pipeline de implantação.
Id	string	The ID of the deployment pipeline run.	097c73fe-ed6e-4fb1-b109-a5d59e46cd58
ProjectId	integer	The project ID.	70199
CreateTime	integer	The creation timestamp of the deployment pipeline run.	1702736654000
ModifyTime	integer	The last modification timestamp of the deployment pipeline run.	1702736654000
Creator	string	The creator of the deployment pipeline run.	110755000425XXXX
Status	string	The status of the deployment pipeline run. Valid values: `Init`: Initializing `Running`: Running `Success`: Succeeded `Fail`: Failed `Termination`: Terminated `Cancel`: Canceled	Running
Message	string	The error message returned if the deployment pipeline run fails.	Error message
Stages	array<object>	A list of deployment stages.
	array<object>	A deployment stage.
Code	string	The code of the deployment stage.	DEV_CHECK
Step	integer	The step number of the deployment stage.	1
Type	string	The type of the deployment stage. Valid values: `Deploy`: A deploy operation `Check`: A check operation `Offline`: An offline operation `Build`: A build operation `Delete`: A delete operation	Check
Name	string	The stage name.	Check before going online to development
Description	string	The stage description.	Check before going online to development
Message	string	The error message returned if the deployment stage fails.	Error message
Status	string	The status of the deployment stage. Valid values: `Init`: Initializing `Running`: Running `Success`: Succeeded `Fail`: Failed `Termination`: Terminated `Cancel`: Canceled	Running
Detail	object	Additional information about the deployment stage.
	any	Additional details for the stage, returned as key-value pairs.	{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }
Description	string	The description of the deployment pipeline run.	Release process description

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\n",
  "PagingInfo": {
    "TotalCount": 2524,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRuns": [
      {
        "Id": "097c73fe-ed6e-4fb1-b109-a5d59e46cd58",
        "ProjectId": 70199,
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "Running",
        "Message": "Error message",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "Check",
            "Name": "Check before going online to development\n",
            "Description": "Check before going online to development\n",
            "Message": "Error message\n",
            "Status": "Running",
            "Detail": {
              "key": "{\n  \"checkerList\": [\n    {\n      \"code\": \"BuildPackageChecker\",\n      \"name\": \"package check\"\n    },\n    {\n      \"code\": \"NodeParentDependency\",\n      \"name\": \"downstream dependency check\"\n    },\n    {\n      \"code\": \"NodeInProcess\",\n      \"name\": \"offline process check\"\n    }\n  ]\n}"
            }
          }
        ],
        "Description": "Release process 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.