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

Atualiza as instâncias em um grupo de escalonamento para aplicar uma nova configuração de escalonamento ou atualizar as imagens das instâncias.

Descrição da operação

Um grupo de escalonamento pode ter apenas um nó de atualização de instância em execução por vez.
Este recurso é suportado apenas para grupos de escalonamento ECS que usam a política de prioridade como política de scale-out. Grupos de escalonamento que usam o número de vCPUs para calcular a capacidade do grupo de escalonamento e grupos de escalonamento cujo padrão de revogação de instância está definido como padrão de revogação de desligamento ou padrão de revogação de desligamento forçado não suportam este recurso.
Durante uma atualização de instância, atividades normais de scale-out e scale-in podem ser realizadas. No entanto, as atividades de scale-out usam a configuração desejada especificada para a atualização de instância.
Instâncias que são adicionadas manualmente ao grupo de escalonamento, ou que estão em estado de espera ou status de proteção, são ignoradas pelo nó de atualização de instância e não são atualizadas.

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

update

*ScalingGroup.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ScalingGroupId	string	Sim	O ID do grupo de escalonamento.	asg-bp18p2yfxow2dloq****
ClientToken	string	Não	Garante a idempotência da solicitação. Você pode gerar o valor no cliente para garantir que o valor seja exclusivo em diferentes solicitações. O valor pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Para mais informações, consulte Como garantir a idempotência.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	Sim	O ID da região do grupo de escalonamento.	cn-hangzhou
MinHealthyPercentage	integer	Não	A porcentagem mínima da capacidade do grupo de escalonamento que deve permanecer em serviço durante a atualização de instância. Valores válidos: 0 a 100. Valor padrão: 80.	80
MaxHealthyPercentage	integer	Não	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ância. Valores válidos: 100 a 200. Valor padrão: 120. Nota Se MinHealthyPercentage e MaxHealthyPercentage forem definidos como 100, uma instância será atualizada por vez.	100
DesiredConfiguration	object	Não	A configuração desejada para a atualização de instância. Nota ScalingConfigurationId, ImageId, LaunchTemplateId e Containers não podem ser especificados ao mesmo tempo. Se este parâmetro for deixado vazio, as instâncias serão atualizadas com base na configuração ativa do grupo de escalonamento. Após a tarefa de atualização de instância ser executada com sucesso, a configuração de escalonamento ativa do grupo de escalonamento é atualizada para esta configuração.
ImageId	string	Não	O ID da imagem. Nota Após a tarefa de atualização de instância ser executada com sucesso, a configuração de imagem na configuração ativa do grupo de escalonamento é atualizada para esta imagem. Este parâmetro não é suportado se a origem da configuração ativa do grupo de escalonamento for um modelo de inicialização. Imagens que contêm discos de dados em nuvem não são suportadas.	m-2ze8cqacj7opnf***
ScalingConfigurationId	string	Não	O ID da configuração de escalonamento.	asc-2zed7lqn4ts4****
LaunchTemplateId	string	Não	O ID do modelo de inicialização. Este parâmetro é usado para especificar que o grupo de escalonamento obtém configurações de inicialização do modelo de inicialização.	lt-2ze2qli30u***
LaunchTemplateVersion	string	Não	A versão do modelo de inicialização. Valores válidos: Um número de versão específico do modelo. Default: sempre usa a versão padrão do modelo. Latest: sempre usa a versão mais recente do modelo. Nota Se a versão for definida como Default ou Latest, a tarefa de atualização de instância não poderá ser revertida.	8
LaunchTemplateOverrides	array<object>	Não	As substituições de tipo de instância para o modelo de inicialização.
	object	Não	As substituições de tipo de instância para o modelo de inicialização.
InstanceType	string	Não	Este parâmetro é usado para especificar o tipo de instância, que substitui o tipo de instância no modelo de inicialização. Nota Este parâmetro entra em vigor apenas quando o parâmetro LaunchTemplateId é especificado.	ecs.c5.2xlarge
Containers	array<object>	Não	A lista de contêineres incluídos na instância. Nota Este parâmetro é suportado apenas para grupos de escalonamento de Elastic Container Instance (ECI). Apenas as configurações de contêiner cujo Container.Name corresponde aos nomes dos contêineres na configuração de escalonamento atual são atualizadas.
	array<object>	Não	A lista de contêineres incluídos na instância.
Name	string	Não	O nome personalizado do contêiner.	nginx
Image	string	Não	A imagem do contêiner.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	Não	Os comandos de inicialização para o contêiner. Você pode especificar até 20 comandos. Cada comando pode conter até 256 caracteres.
	string	Não	Os comandos de inicialização para o contêiner. Você pode especificar até 20 comandos. Cada comando pode conter até 256 caracteres.	sleep
Args	array	Não	Os argumentos para os comandos de inicialização do contêiner. Você pode especificar até 10 argumentos.
	string	Não	Os argumentos para os comandos de inicialização do contêiner. Você pode especificar até 10 argumentos.	100
EnvironmentVars	array<object>	Não	As variáveis de ambiente.
	object	Não	As variáveis de ambiente.
Key	string	Não	O nome da variável de ambiente. O nome deve ter de 1 a 128 caracteres de comprimento. Pode conter letras, dígitos e sublinhados (_), e não pode começar com um dígito.	PATH
Value	string	Não	O valor da variável de ambiente. O valor deve ter de 0 a 256 caracteres de comprimento.	/usr/local/bin
FieldRefFieldPath	string	Não	Nota Este parâmetro não está disponível.	fieldPath
SkipMatching	boolean	Não	Especifica se deve ignorar instâncias que correspondem à configuração desejada. Nota O sistema determina se uma instância corresponde à configuração desejada com base no ID da configuração de escalonamento desejada, sem comparar itens de configuração específicos. Valores válidos: true: ignora as instâncias. Quando a tarefa de atualização de instância é iniciada, o sistema verifica a configuração de cada instância. Instâncias que já foram criadas com a configuração desejada não são atualizadas. false: não ignora as instâncias. Após a tarefa de atualização de instância ser iniciada, todas as instâncias no grupo de escalonamento são atualizadas. Valor padrão: true.	true
Checkpoints	array<object>	Não	Os pontos de verificação para a tarefa de atualização. Este parâmetro especifica que a tarefa é pausada automaticamente pela duração especificada por CheckpointPauseTime em minutos quando a porcentagem de novas instâncias atinge o valor especificado durante a atualização de instância.
	object	Não	Os pontos de verificação para a tarefa de atualização. Este parâmetro especifica que a tarefa é pausada automaticamente pela duração especificada por CheckpointPauseTime em minutos quando a porcentagem de novas instâncias atinge o valor especificado durante a atualização de instância.
Percentage	integer	Não	A porcentagem de novas instâncias em relação ao total de instâncias no grupo de escalonamento. Quando essa porcentagem é atingida, a tarefa é pausada automaticamente. Valores válidos: 1 a 100. Unidade: %. Nota Os valores devem ser definidos em ordem crescente, e a última porcentagem deve ser 100.	20
CheckpointPauseTime	integer	Não	A duração da pausa quando um ponto de verificação da tarefa de atualização é atingido. Unidade: minutos. Valores válidos: 1 a 2880. Valor padrão: 60.	10
Strategy	string	Não	A estratégia de execução para a tarefa de atualização de instância. Valores válidos: Rolling: atualiza instâncias criando novas instâncias e liberando instâncias antigas. ReplaceSystemDisk: atualiza os discos de sistema em nuvem das instâncias existentes especificando DesiredConfiguration.image. Valor padrão: Rolling.	Rolling

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceRefreshTaskId	string	O ID da tarefa de atualização de instância.	ir-a12ds234fasd*****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}

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.