UpdateEndpointGroup - Global Accelerator: Central de Documentação do Alibaba Cloud

Atualiza a configuração de um grupo de endpoints.

Descrição da operação

A API UpdateEndpointGroup é uma API assíncrona. Após chamar esta API, o sistema retorna um ID de solicitação e inicia a atualização em segundo plano; a configuração não é modificada imediatamente. Chame DescribeEndpointGroup para verificar o status do grupo de endpoints:
- Se um grupo de endpoints estiver com o status updating, sua configuração está sendo modificada e você pode realizar apenas consultas.
- Se um grupo de endpoints estiver com o status active, a atualização está concluída.
A API UpdateEndpointGroup não oferece suporte a atualizações simultâneas de grupos de endpoints na mesma instância do Global Accelerator (GA).

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

ga:UpdateEndpointGroup

update

*EndpointGroup

acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região onde a instância do GA está implantada. Defina o valor como cn-hangzhou.	cn-hangzhou
ClientToken	string	Não	Um token gerado pelo cliente para garantir a idempotência da solicitação. O token deve ser exclusivo entre as solicitações e pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como o ClientToken. O RequestId é exclusivo para cada solicitação de API.	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	Sim	O ID do grupo de endpoints.	epg-bp1dmlohjjz4kqaun****
Name	string	Não	O nome do grupo de endpoints. O nome deve ter de 1 a 128 caracteres, começar com uma letra ou um caractere chinês e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-).	group1
Description	string	Não	A descrição do grupo de endpoints. A descrição pode ter até 200 caracteres e não pode começar com `http://` ou `https://`.	EndpointGroup
EndpointGroupRegion	string	Sim	O ID da região onde o grupo de endpoints está implantado.	cn-hangzhou
TrafficPercentage	integer	Não	O peso do grupo de endpoints quando o listener está associado a vários grupos de endpoints.	20
HealthCheckIntervalSeconds	integer	Não	O intervalo entre as verificações de integridade, em segundos. Valores válidos: 1 a 50.	3
HealthCheckPath	string	Não	O caminho para as verificações de integridade.	/healthcheck
HealthCheckPort	integer	Não	A porta usada para as verificações de integridade. Valores válidos: 1 a 65535.	20
HealthCheckProtocol	string	Não	O protocolo para as verificações de integridade. Valores válidos: tcp ou TCP http ou HTTP https ou HTTPS	HTTPS
ThresholdCount	integer	Não	O número de verificações de integridade bem-sucedidas ou com falha consecutivas necessárias para alterar o status de integridade de um endpoint. Valores válidos: 2 a 10.	3
EndpointConfigurations	array<object>	Não	As configurações dos endpoints.
	object	Não	As configurações dos endpoints.
Type	string	Sim	O tipo de endpoint. Valores válidos: Domain: um nome de domínio personalizado. Ip: um endereço IP personalizado. IpTarget: um endereço IP privado personalizado. PublicIp: um endereço IP público do Alibaba Cloud. ECS: uma instância ECS. SLB: uma instância SLB. ALB: uma instância ALB. OSS: uma instância OSS. ENI: uma interface de rede elástica. NLB: uma instância NLB. Nota Se o tipo de endpoint for ECS, ENI, SLB ou IpTarget e a função vinculada ao serviço não existir, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaVpcEndpoint. Se o tipo de endpoint for ALB e a função vinculada ao serviço não existir, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaAlb. Se o tipo de endpoint for OSS e a função vinculada ao serviço não existir, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaOss. Se o tipo de endpoint for NLB e a função vinculada ao serviço não existir, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaNlb. Nota Para obter mais informações, consulte funções vinculadas ao serviço.	Ip
EnableClientIPPreservation	boolean	Não	Especifica se os endereços IP de origem do cliente devem ser preservados. Valores válidos: true: Preserva os endereços IP de origem do cliente. false (padrão): Não preserva os endereços IP de origem do cliente. Nota Para grupos de endpoints de listeners TCP ou UDP, este recurso é desativado por padrão, mas pode ser ativado se necessário. Para grupos de endpoints de listeners HTTP ou HTTPS, os endereços IP de origem do cliente são preservados por padrão. Os endereços IP do cliente são recuperados do cabeçalho X-Forwarded-For. Você não pode desativar este recurso. Você não pode definir `EnableClientIPPreservation` e `EnableProxyProtocol` como `true` ao mesmo tempo. Para obter mais informações, consulte preservar endereços IP de origem do cliente.	false
Weight	integer	Sim	O peso do endpoint. Valores válidos: 0 a 255. Nota Se você definir o peso de um endpoint como 0, o Global Accelerator interromperá a distribuição de tráfego para o endpoint. Prossiga com cautela.	20
EnableProxyProtocol	boolean	Não	Especifica se o Proxy Protocol deve ser usado para preservar os endereços IP de origem do cliente. Valores válidos: true: Preserva os endereços IP de origem do cliente. false (padrão): Não preserva os endereços IP de origem do cliente. Nota Você pode configurar este parâmetro apenas para grupos de endpoints de listeners TCP. Você não pode definir `EnableClientIPPreservation` e `EnableProxyProtocol` como `true` ao mesmo tempo. Para obter mais informações, consulte preservar endereços IP de origem do cliente.	false
Endpoint	string	Sim	Insira um endereço IP, um nome de domínio ou um ID de instância com base no valor do parâmetro `Type`.	120.XX.XX.21
SubAddress	string	Não	O endereço IP privado da interface de rede elástica. Nota Se o tipo de endpoint for ENI, você pode especificar este parâmetro. Se você omitir este parâmetro, o endereço IP privado principal da ENI será usado.	172.168.XX.XX
VpcId	string	Não	O ID da VPC. Você pode especificar no máximo um ID de VPC para um grupo de endpoints associado a um listener de roteamento inteligente. Nota Este parâmetro é obrigatório apenas quando o tipo de endpoint é IpTarget.	vpc-2zen6t0u7xhm0k5iz****
VSwitchIds	array	Não	Uma lista de vSwitches na VPC.
	string	Não	O ID do vSwitch. Você pode especificar no máximo dois IDs de vSwitch para um grupo de endpoints associado a um listener de roteamento inteligente. Nota Este parâmetro é obrigatório apenas quando o tipo de endpoint é IpTarget. O vSwitch deve pertencer à VPC especificada pelo parâmetro `VpcId`.	vsw-2ze2dbtkxabpvpqxc****
Provider	string	Não		BAILIAN
ApiKeys	array	Não
	string	Não		sk-******
EndpointRequestProtocol	string	Não	O protocolo do serviço de back-end. Valores válidos: HTTP HTTPS Nota Você pode configurar este parâmetro apenas para grupos de endpoints de listeners HTTP ou HTTPS. Para um listener HTTP, o protocolo do serviço de back-end deve ser HTTP.	HTTP
EndpointProtocolVersion	string	Não	A versão do protocolo do serviço de back-end. Valores válidos: HTTP1.1 HTTP2 Nota Você pode configurar este parâmetro apenas quando `EndpointRequestProtocol` estiver definido como HTTPS.	HTTP1.1
PortOverrides	array<object>	Não	As configurações de substituição de porta.
	object	Não	As configurações de substituição de porta.
ListenerPort	integer	Não	A porta do listener nas configurações de substituição de porta. Nota Para listeners TCP, os grupos de endpoints virtuais não oferecem suporte a substituições de porta. Se um listener já estiver associado a um grupo de endpoints virtual, você não poderá configurar substituições de porta para o grupo de endpoints padrão. Se o grupo de endpoints padrão tiver substituições de porta configuradas, você não poderá adicionar um grupo de endpoints virtual. Depois de configurar as substituições de porta, você poderá alterar o protocolo do listener apenas entre HTTP e HTTPS. O intervalo de portas do listener atualizado deve incluir todas as portas do listener nas substituições de porta configuradas. Por exemplo, se o intervalo de portas do listener for 80-82 e as substituições de porta estiverem configuradas para mapear as portas para as portas de endpoint 100-102, você não poderá atualizar o intervalo de portas do listener para 80-81.	443
EndpointPort	integer	Não	A porta do endpoint nas configurações de substituição de porta.	80
HealthCheckEnabled	boolean	Não	Especifica se as verificações de integridade devem ser ativadas. Valores válidos: true: Ativa as verificações de integridade. false (padrão): Desativa as verificações de integridade.	true
HealthCheckHost	string	Não	O nome de domínio para a verificação de integridade.	www.taobao.com
EndpointIpVersion	string	Não	Especifica o protocolo IP que o GA usa para se comunicar com os endpoints. Valores válidos: ● IPv4 (padrão): Usa IPv4. ● IPv6: Usa IPv6. ● ProtocolAffinity: Usa o mesmo protocolo IP da solicitação do cliente.	IPv4

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados na resposta.
RequestId	string	O ID da solicitação.	6FEA0CF3-D3B9-43E5-A304-D217037876A8

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	The current account does not have the permissions to enable health checks.
400	NotExist.EndPointGroup	The endpoint group does not exist.	The endpoint group does not exist.
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.	The endpoint group is in an invalid state.
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The listener is unstable.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	The user does not have permissions to create service linked roles. Contact the Alibaba Cloud account owner or the permission administrator to grant the current user AliyunGlobalAccelerationFullAccess or create custom permission policies for service linked role. The following content describes the detailed information about custom permission policies: ServiceName: vpcendpoint.ga.aliyuncs.com. Service linked role name: AliyunServiceRoleForGaVpc. Endpoint Permission: ram:CreateServiceLinkedRole.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	The number of port override exceeds the limit.
400	NotExist.ListenerPort	listener port %s is not exist

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.