DescribePipeline - Serverless App Engine: Central de Documentação do Alibaba Cloud

Consulta as informações do lote.

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

sae:DescribePipeline

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/changeorder/DescribePipeline HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PipelineId	string	Sim	O ID do lote. Você pode chamar a operação DescribeChangeOrder para obter o ID.	917660ba-5092-44ca-b8e0-80012c96****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta das informações do lote.
RequestId	string	O ID da solicitação.	559B4247-C41C-4D9E-B866-B55D360B****
Message	string	A mensagem retornada para a operação.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes da solicitação.	0be3e0c316390414649128666e****
Data	object	As informações do lote.
ShowBatch	boolean	Indica se deve iniciar o processamento do próximo lote. Valores válidos: false: indica que o próximo lote ainda não pode ser processado. true: indica que o próximo lote pode ser processado agora.	false
PipelineStatus	integer	O status do lote. Valores válidos: 0: O lote está preparado para processamento. 1: A tarefa está sendo executada. 2: Bem-sucedido 3: O processamento falhou nesta etapa. 6: O processamento do lote foi encerrado. 10: O lote não pôde ser processado devido a uma exceção do sistema.	2
CurrentStageId	string	O ID da etapa de processamento do lote.	c3a55592-4c30-4d84-ac2d-e98c18ec****
PipelineName	string	O nome do lote.	Batch 1 change
StageList	array<object>	A lista de etapas de processamento do lote.
	array<object>	As informações sobre a etapa.
Status	integer	The status of the batch processing stage. Valid values: 0: The batch is prepared for this processing stage. 1: The task is being executed. 2: successful 3: The processing failed in this stage. 6: The processing stage was terminated.	2
StageId	string	The ID of the stage.	c3a55592-4c30-4d84-ac2d-e98c18ec****
ExecutorType	integer	The execution type of the stage. Valid values: 0: in sequence. 1: in parallel.	0
TaskList	array<object>	The list of task statuses.
	object	The information about the task status.
Status	integer	The task status. Valid values: 0: The task is prepared for execution. 1: The task is being executed. 2: successful 3: The task could not be executed. 5: The task is pending retry. 6: The task was terminated.	2
StageId	string	The ID of the stage.	c3a55592-4c30-4d84-ac2d-e98c18ec****
ErrorMessage	string	The error message returned when the task could not be executed. If the task is successfully executed, this parameter is not returned.	EDAS-10022
ErrorCode	string	The error code returned when the task could not be executed. If the task is successfully executed, this parameter is not returned.	EDAS-10022
TaskName	string	The name of the task.	Initialize environment
ErrorIgnore	integer	Indicates whether to execute the subsequent tasks when the task failed. Valid values: 0: The subsequent tasks cannot be executed. 1: The subsequent tasks can be executed.	0
Message	string	The returned message indicating the task execution result.	init Namespace success
ShowManualIgnore	boolean	Indicates whether a running task can be manually skipped. Valid values: true: The running task can be skipped. false: The zone does not allow you to change the network type of an ApsaraDB for Redis instance from classic network to VPC.	false
TaskId	string	The ID of the task.	bef0122f-de9a-4ab0-8223-b88bf8ad****
StageName	string	The name of the stage.	Deployment application
NextPipelineId	string	O ID do próximo lote.	b77b1c98-5772-4f05-95fc-c7bee5fa****
PipelineId	string	O ID do lote.	917660ba-5092-44ca-b8e0-80012c96****
CoStatus	string	O status da ordem de alteração do lote.	Execution succeeded
ErrorCode	string	O código de erro retornado se a solicitação falhar. Observe as seguintes regras: O parâmetro ErrorCode não é retornado se a solicitação for bem-sucedida. Se a chamada falhar, o parâmetro ErrorCode será retornado. Para obter mais informações, consulte a seção "Códigos de erro" deste tópico.
Code	string	O código de status HTTP. Valores válidos: 2xx: A chamada foi bem-sucedida. 3xx: A chamada foi redirecionada. 4xx: A chamada falhou. 5xx: Ocorreu um erro no servidor.	200
Success	boolean	Indica se as informações do lote foram obtidas. Valores válidos: true: As informações foram consultadas. false: Falha ao localizar a imagem.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "success",
  "TraceId": "0be3e0c316390414649128666e****",
  "Data": {
    "ShowBatch": false,
    "PipelineStatus": 2,
    "CurrentStageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
    "PipelineName": "Batch 1 change",
    "StageList": [
      {
        "Status": 2,
        "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
        "ExecutorType": 0,
        "TaskList": [
          {
            "Status": 2,
            "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
            "ErrorMessage": "EDAS-10022 ",
            "ErrorCode": "EDAS-10022",
            "TaskName": "Initialize environment",
            "ErrorIgnore": 0,
            "Message": "init Namespace success",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "Deployment application"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "Execution succeeded"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.NoPermission	Resource no permission

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.