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

Obtém informações sobre uma ordem de mudança.

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

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ChangeOrderId	string	Sim	O ID da ordem de mudança. Você pode obtê-lo chamando a API ListChangeOrders.	76fa5c0-9ebb-4bb4-b383-1f885447****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	A mensagem retornada para a solicitação.	success
TraceId	string	O ID de rastreamento da solicitação. Este ID é usado para solução de problemas.	0a98a02315955564772843261e****
Data	object	Os detalhes da ordem de mudança.
Status	integer	O status da ordem de mudança. Valores válidos: 0: Preparando 1: Em andamento 2: Bem-sucedido 3: Falhou 6: Encerrado 8: Aguardando confirmação manual 9: Aguardando confirmação automática 10: Falha devido a um erro do sistema 11: Aprovação pendente 12: Aprovado e execução pendente	2
SubStatus	integer	O substatus da ordem de liberação. Este parâmetro indica se ocorreu uma exceção durante a liberação. Valores válidos: 0: Normal. 1: Anormal. Por exemplo, se uma liberação em lote falhar, você deve executar manualmente uma reversão, deixando a ordem de liberação no estado Em andamento.	0
ApprovalId	string	O ID de aprovação da operação.	67de0b39-a9d4-4c09-a170-cf438208****
ErrorMessage	string	A mensagem de erro.	success
BatchWaitTime	integer	O tempo de espera, em minutos, entre lotes em uma liberação automática.	0
CreateTime	string	A hora em que a ordem de mudança foi criada.	2020-12-17 21:06:45
BatchCount	integer	O número de lotes.	1
CoTypeCode	string	O código do tipo de mudança. Valores válidos: CoBindSlb: Vincula uma instância SLB. CoUnbindSlb: Desvincula uma instância SLB. CoCreateApp: Cria um aplicativo. CoDeleteApp: Exclui um aplicativo. CoDeploy: Implanta um aplicativo. CoRestartApplication: Reinicia um aplicativo. CoRollback: Reverte um aplicativo. CoScaleIn: Reduz a escala de um aplicativo. CoScaleOut: Aumenta a escala de um aplicativo. CoStart: Inicia um aplicativo. CoStop: Para um aplicativo. CoRescaleApplicationVertically: Modifica as especificações da instância. CoDeployHistroy: Reverte para uma versão histórica. CoBindNas: Vincula um sistema de arquivos NAS. CoUnbindNas: Desvincula um sistema de arquivos NAS. CoBatchStartApplication: Inicia aplicativos em lotes. CoBatchStopApplication: Para aplicativos em lotes. CoRestartInstances: Reinicia instâncias. CoDeleteInstances: Exclui instâncias. CoScaleInAppWithInstances: Reduz a escala de um aplicativo especificando instâncias.	CoRestartInstances
SupportRollback	boolean	Indica se a reversão é suportada. Valores válidos: true: A reversão é suportada. false: A reversão não é suportada.	false
ChangeOrderId	string	O ID da ordem de mudança.	765fa5c0-9ebb-4bb4-b383-1f885447**
AppName	string	O nome do aplicativo.	app-test
BatchType	string	O modo de liberação para lotes. Valores válidos: auto: Liberação automática. manual: Liberação manual.	auto
Description	string	A descrição da ordem de mudança.	description
CoType	string	O tipo de mudança. Este parâmetro é uma descrição de CoTypeCode.	Batch Restart Instances
Auto	boolean	Indica se a mudança deve ser liberada automaticamente em lotes. Valores válidos: true: A mudança é liberada automaticamente. false: A mudança não é liberada automaticamente.	true
CurrentPipelineId	string	O ID do lote atual.	0e4acf82-c9b1-4c1e-ac28-55776338****
Pipelines	array<object>	As informações do lote.
	object	As informações sobre um lote.
Status	integer	The status of the batch. Valid values: 0: Preparing 1: In progress 2: Succeeded 3: Failed 6: Terminated 8: Awaiting manual confirmation 9: Awaiting automatic confirmation 10: Failed due to a system error 11: Pending approval 12: Approved and pending execution	2
StartTime	integer	The start time of the batch.	1562831689704
UpdateTime	integer	The time when the batch was last updated.	1562847178007
BatchType	integer	The batch type.	0
ParallelCount	integer	The number of parallel tasks in a batch.	0
PipelineName	string	The batch name.	Batch 1 Change
PipelineId	string	The batch ID.	0e4acf82-c9b1-4c1e-ac28-55776338****
AppId	string	O ID do aplicativo.	bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
ApplicationUpdateStrategy	string	A estratégia de atualização do aplicativo.
ApplicationEnableGreyTagRoute	boolean	Indica se o roteamento de tags cinza está ativado.
ErrorCode	string	O código de erro. Se a solicitação for bem-sucedida, este parâmetro não será retornado. Se a solicitação falhar, este parâmetro 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 ou código de erro POP. Valores válidos: 2xx: A solicitação foi bem-sucedida. 3xx: A solicitação foi redirecionada. 4xx: Ocorreu um erro no lado do cliente. 5xx: Ocorreu um erro no lado do servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "Batch Restart Instances",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****",
    "ApplicationUpdateStrategy": "",
    "ApplicationEnableGreyTagRoute": false
  },
  "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	Resouce.no.permission	You are not authorized to operate on the specified resources.	You are not authorized to operate on the specified resources.
400	InvalidChangeOrder.NotFound	The current change order does not exist.	The current change order does not exist.
404	InvalidAppId.NotFound	The specified AppId does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.