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

Atualiza instâncias em um grupo de escalonamento quando é necessário aplicar uma nova configuração de escalonamento ou atualizar a imagem das instâncias no grupo de escalonamento.

Descrição da operação

Um grupo de escalonamento pode ter apenas uma tarefa de atualização de instâncias em execução por vez.
Atualmente, esse recurso é suportado apenas para grupos de escalonamento ECS cuja política de scale-out está definida como Política de prioridade. Grupos de escalonamento que usam Cálculo de capacidade baseado em vCPU e grupos de escalonamento cujo modo de recuperação de instâncias está definido como Modo de desligamento e recuperação ou Modo de desligamento forçado e recuperação não suportam este recurso.
Durante uma atualização de instâncias, operações normais de scale-out e scale-in podem ser realizadas. No entanto, as operações de scale-out usam a configuração desejada especificada na tarefa de atualização de instâncias.
Instâncias adicionadas manualmente ao grupo de escalonamento, instâncias no estado de espera e instâncias no estado protegido são ignoradas pela tarefa de atualização de instâncias e não participam da atualização de instâncias.

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
RegionId	string	Sim	O ID da região do grupo de escalonamento.	cn-hangzhou
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token 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****
ScalingGroupId	string	Sim	O ID do grupo de escalonamento.	asg-bp18p2yfxow2dloq****
MinHealthyPercentage	integer	Não	A porcentagem mínima de instâncias que devem permanecer em serviço no grupo de escalonamento durante a atualização de instâncias. 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âncias. Valores válidos: 100 a 200. Valor padrão: 120. Nota Se você definir MinHealthyPercentage e MaxHealthyPercentage como 100, uma instância será atualizada por vez.	100
DesiredConfiguration	object	Não	A configuração desejada para a atualização de instâncias. Nota Você não pode especificar ScalingConfigurationId, ImageId, LaunchTemplateId e Containers ao mesmo tempo. Você deve especificar um deles. A tarefa de atualização ignora as instâncias no grupo de escalonamento que já correspondem à configuração desejada.
ImageId	string	Não	O ID da imagem. Nota Após a conclusão da tarefa de atualização de instâncias, a configuração de imagem na configuração ativa do grupo de escalonamento é atualizada para esta imagem. Este parâmetro não é suportado quando a origem da configuração de instância do grupo de escalonamento é um launch template. 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. Nota Após a conclusão da tarefa de atualização de instâncias, a configuração de escalonamento ativa do grupo de escalonamento é atualizada para esta configuração.	asc-2zed7lqn4ts4****
LaunchTemplateId	string	Não	O ID do launch template. Este parâmetro especifica que o grupo de escalonamento obtém informações de configuração de inicialização do launch template.	lt-2ze2qli30u***
LaunchTemplateVersion	string	Não	A versão do launch template. Valores válidos: Um número de versão fixo 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 estiver definida como Default ou Latest, a tarefa de atualização de instâncias não suportará rollback.	8
LaunchTemplateOverrides	array<object>	Não	As informações de tipo de instância que estendem o launch template.
	object	Não	As informações de tipo de instância que estendem o launch template.
InstanceType	string	Não	O tipo de instância que substitui o tipo de instância especificado no launch template.	ecs.g7.2xlarge
Containers	array<object>	Não	A lista de contêineres incluídos na instância.
	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 do contêiner. Há suporte para no máximo 20 comandos. Cada comando pode conter até 256 caracteres.
	string	Não	O comando de inicialização do contêiner. O comando pode conter até 256 caracteres.	sleep
Args	array	Não	Os argumentos para o comando de inicialização do contêiner. Há suporte para no máximo 10 argumentos.
	string	Não	O argumento para o comando de inicialização do contêiner.	100
EnvironmentVars	array<object>	Não	As informações da variável de ambiente.
	object	Não	As informações da variável de ambiente.
Key	string	Não	O nome da variável de ambiente. O nome deve ter de 1 a 128 caracteres de comprimento e pode conter dígitos, letras e sublinhados (_). Não pode começar com um dígito.	PATH
Value	string	Não	O valor da variável de ambiente. O valor pode ter de 0 a 256 caracteres de comprimento.	/usr/local/bin
FieldRefFieldPath	string	Não	Nota Este parâmetro não está disponível publicamente.	fieldPath
SkipMatching	boolean	Não	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: Ignora as instâncias correspondentes. 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 ignora as instâncias correspondentes. Após o início da tarefa de atualização de instâncias, 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. Especifica que a tarefa é pausada automaticamente pela duração especificada por CheckpointPauseTime quando a porcentagem de novas instâncias atinge o valor especificado durante a atualização de instâncias.
	object	Não	Os pontos de verificação para a tarefa de atualização. Especifica que a tarefa é pausada automaticamente pela duração especificada por CheckpointPauseTime quando a porcentagem de novas instâncias atinge o valor especificado durante a atualização de instâncias.
Percentage	integer	Não	A porcentagem de novas instâncias em relação ao total de instâncias no grupo de escalonamento. A tarefa é pausada automaticamente quando essa porcentagem é atingida. Valores válidos: 1 a 100 (%). Nota Os valores devem ser especificados em ordem crescente, e o último valor de 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âncias. Valores válidos: Rolling: A tarefa de atualização de instâncias cria novas instâncias e libera instâncias antigas para atualizar as instâncias. ReplaceSystemDisk: Atualiza o disco de sistema em nuvem nas instâncias existentes especificando DesiredConfiguration.image para substituir o disco de sistema em nuvem das instâncias. 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âncias.	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.