DescribeServiceRollout - Platform For AI: Central de Documentação do Alibaba Cloud

Consulta o plano de atualização do serviço.

Descrição da operação

Esta operação consulta a configuração de rollout e o status de execução atual de um serviço específico.
As informações retornadas incluem, mas não se limitam a, os parâmetros específicos da estratégia de rollout e o progresso atual do rollout.
Especifique ClusterId e o nome do serviço ServiceName como parâmetros de caminho na solicitação.
O limite de taxa de solicitação é de 100 solicitações por segundo.
Se o serviço não existir ou nenhuma estratégia de rollout tiver sido criada, esta operação retornará um erro.
O status retornado é um resultado de consulta em tempo real que pode mudar ao longo do tempo. Ajuste o intervalo de polling conforme necessário.

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

eas:DescribeServiceRollout

get

*All resources.

*

Nenhuma

Sintaxe da solicitação

GET /api/v2/services/{ClusterId}/{ServiceName}/rollout HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Não	O ID da região do cluster onde o serviço reside.	cn-shanghai
ServiceName	string	Não	O nome do serviço.	foo

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação. Um identificador exclusivo retornado com cada solicitação, usado para solução de problemas e rastreamento.	40325405-579C-4D82****
Rollout	object	As informações da estratégia de rollout. Contém a configuração da estratégia (Strategy) e o status de execução (Status).
Strategy	object	A configuração da estratégia de rollout. Contém os parâmetros de configuração específicos para rollout baseado em partições ou em lotes.
Partition	object	A configuração de rollout por partição. Este campo é retornado apenas se uma estratégia de rollout baseada em partições for utilizada.
Partition	string	O valor da partição. Especifica o número ou a porcentagem de réplicas antigas a serem retidas. Por exemplo, '50%' indica que 50% das réplicas antigas são retidas.	50%
Batch	object	A configuração de rollout em lotes. Este campo é retornado apenas se uma estratégia de rollout baseada em lotes for utilizada.
BatchSize	string	O tamanho do lote. O número ou a porcentagem de réplicas a serem atualizadas em cada lote.	1
Interval	string	O intervalo do lote. O tempo de espera entre dois lotes de rollout consecutivos.	5m
Status	object	O status de execução do rollout. Contém o progresso atual do rollout e informações de fase.
Phase	string	A fase do rollout. Valores válidos:\n- Pending: Aguardando o início do rollout.\n- Running: O rollout está em andamento.\n- Paused: O rollout está pausado.\n- Completed: O rollout foi concluído.\n- Failed: O rollout falhou. Valores válidos: Failed : O rollout falhou. Completed : O rollout foi concluído. Running : O rollout está em andamento. Pending : Aguardando o início do rollout. Paused : O rollout está pausado.	Running
TotalReplicas	integer	O número total de réplicas do serviço.	10
UpdatedReplicas	integer	O número de réplicas que foram atualizadas para a nova versão.	5
CurrentRevision	string	A revisão atual. O identificador da versão que está em execução no momento.	service-abc123-v1
UpdateRevision	string	A revisão de atualização. O identificador da versão de destino para a qual o serviço está sendo atualizado.	service-abc123-v2
NextBatchStartTime	string	A hora em que o próximo lote começa a ser atualizado, no formato AAAA/MM/DD HH:mm:ss.	2026/05/08 16:10:56

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "40325405-579C-4D82****",
  "Rollout": {
    "Strategy": {
      "Partition": {
        "Partition": "50%"
      },
      "Batch": {
        "BatchSize": "1",
        "Interval": "5m"
      }
    },
    "Status": {
      "Phase": "Running",
      "TotalReplicas": 10,
      "UpdatedReplicas": 5,
      "CurrentRevision": "service-abc123-v1",
      "UpdateRevision": "service-abc123-v2",
      "NextBatchStartTime": "2026/05/08 16:10:56"
    }
  }
}

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.