DescribeInstanceRefreshes - Auto Scaling: Central de Documentação do Alibaba Cloud

Consulta as tarefas de atualização de instâncias de um grupo de escalonamento, incluindo informações básicas e o progresso das tarefas.

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

ess:DescribeInstanceRefreshes

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do grupo de escalonamento.	cn-hangzhou
NextToken	string	Não	O token de paginação. Defina este parâmetro como o valor NextToken retornado na chamada anterior. Você não precisa definir este parâmetro para a primeira solicitação.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Não	O número máximo de entradas por página em uma consulta paginada. Valores válidos: 1 a 50. Valor padrão: 10.	10
ScalingGroupId	string	Sim	O ID do grupo de escalonamento.	asg-bp1ffogfdauy0jw0****
InstanceRefreshTaskId	array	Não	O ID da tarefa de atualização de instâncias que você deseja consultar.
	string	Não	O ID da tarefa de atualização de instâncias que você deseja consultar. Valores válidos de N: 1 a 20.	ir-adfa12312*****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	O token de paginação para a próxima consulta. Se NextToken estiver vazio, não existem mais resultados.	caeba0bbb2be03f84eb48b699f****
MaxResults	integer	O número máximo de entradas por página.	50
TotalCount	integer	O número total de tarefas de atualização de instâncias.	100
InstanceRefreshTasks	object
InstanceRefreshTask	array<object>	A lista de tarefas de atualização de instâncias.
	array<object>	A tarefa de atualização de instâncias.
InstanceRefreshTaskId	string	O ID da tarefa de atualização de instâncias.	ir-1adfa123****
ScalingGroupId	string	O ID do grupo de escalonamento.	asg-bp16pbfcr8j9*****
RegionId	string	O ID da região do grupo de escalonamento.	cn-hangzhou
EndTime	string	A hora de término da tarefa de atualização de instâncias.	2024-08-22T02:09:00Z
StartTime	string	A hora de início da tarefa de atualização de instâncias.	2024-08-22T01:09:00Z
Status	string	O status atual da tarefa de atualização de instâncias. Valores válidos: Pending: A tarefa de atualização de instâncias foi criada e está aguardando para ser agendada. InProgress: A tarefa de atualização de instâncias está em andamento. Paused: A tarefa de atualização de instâncias está pausada. CheckpointPause: A tarefa de atualização de instâncias está pausada porque o progresso da tarefa atingiu um ponto de verificação (Checkpoint.Percentage). Failed: A tarefa de atualização de instâncias falhou. Successful: A tarefa de atualização de instâncias foi bem-sucedida. Cancelling: A tarefa de atualização de instâncias está sendo cancelada. Cancelled: A tarefa de atualização de instâncias foi cancelada. RollbackInProgress: A tarefa de atualização de instâncias está sendo revertida. RollbackSuccessful: A tarefa de atualização de instâncias foi revertida. RollbackFailed: A reversão da tarefa de atualização de instâncias falhou.	InProgress
Detail	string	O motivo específico da falha quando a tarefa de atualização de instâncias falha.	A tarefa excedeu seu tempo máximo de execução de uma semana. Portanto, a tarefa falhou
MinHealthyPercentage	integer	A porcentagem mínima de instâncias que devem permanecer em serviço no grupo de escalonamento durante a atualização de instâncias.	80
MaxHealthyPercentage	integer	A porcentagem máxima pela qual o número de instâncias no grupo de escalonamento pode exceder a capacidade do grupo de escalonamento durante a atualização de instâncias.	120
DesiredConfiguration	object	A configuração desejada para a atualização de instâncias.
ImageId	string	O ID do arquivo de imagem usado para a criação automática de instâncias.	m-uf6g5noisr****
ScalingConfigurationId	string	O ID da configuração de escalonamento.	asc-wz91ibkhfor****
LaunchTemplateId	string	O ID do modelo de inicialização usado pelo grupo de escalonamento para obter informações de configuração de inicialização.	lt-2ze5x4mp*****
LaunchTemplateVersion	string	A versão do modelo de inicialização. Valores válidos: Um número de versão fixo do modelo. Default: usa sempre a versão padrão do modelo. Latest: usa sempre a versão mais recente do modelo.	Latest
LaunchTemplateOverrides	object
LaunchTemplateOverride	array<object>	As informações de tipo de instância que estendem o modelo de inicialização.
	object	As informações de tipo de instância que estendem o modelo de inicialização.
InstanceType	string	O tipo de instância especificado, que substitui o tipo de instância no modelo de inicialização.	ecs.g7.2xlarge
Containers	object
Container	array<object>	A lista de contêineres incluídos na instância.
	array<object>	A lista de contêineres incluídos na instância.
Name	string	O nome personalizado do contêiner.	nome
Image	string	A imagem do contêiner.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	object
Command	array	O comando de inicialização do contêiner.
	string	O comando de inicialização do contêiner.	sleep
EnvironmentVars	object
EnvironmentVar	array<object>	As informações da variável de ambiente.
	object	As informações da variável de ambiente.
Key	string	O nome da variável de ambiente.	PATH
Value	string	O valor da variável de ambiente.	/usr/local/bin
FieldRefFieldPath	string	Nota Este parâmetro não está disponível para uso.	fieldPath
Args	object
Arg	array	Os argumentos para o comando de inicialização do contêiner.
	string	Os argumentos para o comando de inicialização do contêiner.	100
FinishedUpdateCapacity	integer	A capacidade que foi atualizada.	10
TotalNeedUpdateCapacity	integer	A capacidade total que precisa ser atualizada.	20
SkipMatching	boolean	Especifica se devem ser ignoradas as instâncias que correspondem à configuração desejada. Nota O sistema determina se uma instância corresponde com base no ID da configuração de escalonamento desejada, e não comparando itens de configuração específicos. Valores válidos: true: Ignorado. Quando a tarefa de atualização de instâncias é iniciada, o sistema verifica a configuração de cada instância. As instâncias que já foram criadas com a configuração desejada não são atualizadas. false: Não ignorado. Após o início da tarefa de atualização de instâncias, todas as instâncias no grupo de escalonamento são atualizadas.	true
CheckpointPauseTime	integer	A duração pela qual a tarefa pausa quando um ponto de verificação é atingido. Unidade: minutos.	30
Checkpoints	object
Checkpoint	array<object>	O ponto de verificação da tarefa de atualização. Especifica que a tarefa pausa automaticamente por CheckpointPauseTime minutos quando a proporção de novas instâncias atinge o valor especificado durante a atualização de instâncias.
	object	O ponto de verificação da tarefa de atualização. Especifica que a tarefa pausa automaticamente por CheckpointPauseTime minutos quando a proporção de novas instâncias atinge o valor especificado durante a atualização de instâncias.
Percentage	integer	A porcentagem de novas instâncias em relação ao total de instâncias no grupo de escalonamento. A tarefa pausa automaticamente quando essa porcentagem é atingida.	60
Strategy	string

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken": "caeba0bbb2be03f84eb48b699f****",
  "MaxResults": 50,
  "TotalCount": 100,
  "InstanceRefreshTasks": {
    "InstanceRefreshTask": [
      {
        "InstanceRefreshTaskId": "ir-1adfa123****",
        "ScalingGroupId": "asg-bp16pbfcr8j9*****",
        "RegionId": "cn-hangzhou",
        "EndTime": "2024-08-22T02:09:00Z",
        "StartTime": "2024-08-22T01:09:00Z",
        "Status": "InProgress",
        "Detail": "The task exceeded its maximum run time of one week. So the task failed.",
        "MinHealthyPercentage": 80,
        "MaxHealthyPercentage": 120,
        "DesiredConfiguration": {
          "ImageId": "m-uf6g5noisr****",
          "ScalingConfigurationId": "asc-wz91ibkhfor****",
          "LaunchTemplateId": "lt-2ze5x4mp*****",
          "LaunchTemplateVersion": "Latest",
          "LaunchTemplateOverrides": {
            "LaunchTemplateOverride": [
              {
                "InstanceType": "ecs.g7.2xlarge"
              }
            ]
          },
          "Containers": {
            "Container": [
              {
                "Name": "name",
                "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
                "Commands": {
                  "Command": [
                    "sleep"
                  ]
                },
                "EnvironmentVars": {
                  "EnvironmentVar": [
                    {
                      "Key": "PATH",
                      "Value": "/usr/local/bin",
                      "FieldRefFieldPath": "fieldPath"
                    }
                  ]
                },
                "Args": {
                  "Arg": [
                    "100"
                  ]
                }
              }
            ]
          }
        },
        "FinishedUpdateCapacity": 10,
        "TotalNeedUpdateCapacity": 20,
        "SkipMatching": true,
        "CheckpointPauseTime": 30,
        "Checkpoints": {
          "Checkpoint": [
            {
              "Percentage": 60
            }
          ]
        },
        "Strategy": ""
      }
    ]
  }
}

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.