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

Modifica as configurações de um grupo de endpoints.

Descrição da operação

A operação UpdateEndpointGroup é assíncrona. O sistema retorna um ID de solicitação, mas as configurações do grupo de endpoints não são modificadas imediatamente. A tarefa de modificação continua em segundo plano. Você pode chamar a operação DescribeEndpointGroup para consultar o status do grupo de endpoints:
- Se o grupo de endpoints estiver no estado updating, as configurações estão sendo modificadas. Nesse estado, você pode realizar apenas operações de consulta.
- Se o grupo de endpoints estiver no estado active, as configurações foram modificadas.
A operação UpdateEndpointGroup não suporta modificações simultâneas nas configurações do grupo 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 da instância do Global Accelerator (GA). Defina o valor como cn-hangzhou.	cn-hangzhou
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode gerar o token em seu cliente. Certifique-se de que o token seja exclusivo entre diferentes solicitações. O token de cliente suporta apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como ClientToken. O RequestId é diferente 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 e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra ou um caractere chinês.	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 `deprecated`	string	Não	O ID da região do grupo de endpoints.	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 dois health checks consecutivos. Unidade: segundos. Valores válidos: 1 a 50.	3
HealthCheckPath	string	Não	O caminho do health check.	/healthcheck
HealthCheckPort	integer	Não	A porta do health check. Valores válidos: 1 a 65535.	20
HealthCheckProtocol	string	Não	O protocolo do health check. Valores válidos: tcp ou TCP: TCP. http ou HTTP: HTTP. https ou HTTPS: HTTPS.	HTTPS
ThresholdCount	integer	Não	O número de health checks consecutivos necessários para alterar o status do health check. Isso se refere ao número de health checks com falha consecutivos necessários para alterar o status de íntegro para não íntegro, ou ao número de health checks bem-sucedidos consecutivos necessários para alterar o status de não íntegro para íntegro. Valores válidos: 2 a 10.	3
EndpointConfigurations	array<object>	Não	As configurações do endpoint.
	object	Não	As configurações do endpoint.
Type	string	Sim	O tipo de endpoint. Valores válidos: Domain: nome de domínio personalizado. Ip: endereço IP personalizado. IpTarget: IP privado personalizado. PublicIp: endereço IP público da Alibaba Cloud. ECS: instância ECS da Alibaba Cloud. SLB: instância SLB da Alibaba Cloud. ALB: instância ALB da Alibaba Cloud. OSS: instância OSS da Alibaba Cloud. ENI: controlador de interface de rede elástica (NIC) da Alibaba Cloud. NLB: instância NLB da Alibaba Cloud. Nota Se o tipo de endpoint estiver definido como ECS, ENI, SLB, ALB, NLB ou IpTarget e a função vinculada a serviço não existir, o sistema criará automaticamente uma função vinculada a serviço chamada AliyunServiceRoleForGaVpcEndpoint. Se o tipo de endpoint estiver definido como ALB e a função vinculada a serviço não existir, o sistema criará automaticamente uma função vinculada a serviço chamada AliyunServiceRoleForGaAlb. Se o tipo de endpoint estiver definido como OSS e a função vinculada a serviço não existir, o sistema criará automaticamente uma função vinculada a serviço chamada AliyunServiceRoleForGaOss. Se o tipo de endpoint estiver definido como NLB e a função vinculada a serviço não existir, o sistema criará automaticamente uma função vinculada a serviço chamada AliyunServiceRoleForGaNlb. Nota Para mais informações, consulte Funções vinculadas a serviço.	Ip
EnableClientIPPreservation	boolean	Não	Especifica se a preservação do endereço IP do cliente deve ser ativada usando o método de recuperação automática. Valores válidos: true: ativa a preservação do endereço IP do cliente. false (padrão): desativa a preservação do endereço IP do cliente. Nota Por padrão, a preservação do endereço IP do cliente é desativada para grupos de endpoints associados a listeners UDP ou TCP. Você pode configurar esse recurso com base nos requisitos do seu negócio. Por padrão, a preservação do endereço IP do cliente é ativada para grupos de endpoints associados a listeners HTTP ou HTTPS. Os endereços IP do cliente são obtidos por meio do campo de cabeçalho X-Forwarded-For. Você não pode desativar esse recurso. Você não pode definir EnableClientIPPreservation e EnableProxyProtocol como true simultaneamente. Para mais informações, consulte Preservar endereços IP do cliente.	false
Weight	integer	Sim	O peso do endpoint. Valores válidos: 0 a 255. Nota Se o peso de um endpoint for definido como 0, o Global Accelerator para de distribuir tráfego para o endpoint. Prossiga com cautela.	20
EnableProxyProtocol	boolean	Não	Especifica se a preservação do endereço IP do cliente deve ser ativada usando o Proxy Protocol. Valores válidos: true: ativa a preservação do endereço IP do cliente. false (padrão): desativa a preservação do endereço IP do cliente. Nota Este parâmetro é suportado apenas para grupos de endpoints associados a listeners TCP. Você não pode definir EnableClientIPPreservation e EnableProxyProtocol como true simultaneamente. Para mais informações, consulte Preservar endereços IP do cliente.	false
Endpoint	string	Sim	O endereço IP, nome de domínio ou ID da instância do endpoint. Especifique este parâmetro com base no tipo de endpoint.	120.XX.XX.21
SubAddress	string	Não	O endereço IP privado do controlador de interface de rede elástica (NIC). Nota Este parâmetro é opcional quando o tipo de endpoint está definido como ENI. Se você não especificar este parâmetro, o endereço IP privado principal da ENI será usado por padrão.	172.168.XX.XX
VpcId	string	Não	O ID da nuvem privada virtual (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 e entra em vigor apenas quando o tipo de endpoint está definido como IpTarget.	vpc-2zen6t0u7xhm0k5iz****
VSwitchIds	array	Não	Os 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 e entra em vigor apenas quando o tipo de endpoint está definido como IpTarget. O vSwitch deve pertencer à VPC especificada pelo parâmetro VpcId.	vsw-2ze2dbtkxabpvpqxc****
Provider	string	Não	O provedor de serviços nas configurações do endpoint.	BAILIAN
ApiKeys	array	Não	As chaves de API nas configurações do endpoint.
	string	Não	A primeira chave de API nas configurações do endpoint.	sk-******
EndpointRequestProtocol	string	Não	O protocolo do serviço de backend. Valores válidos: HTTP HTTPS Nota Este parâmetro é suportado apenas quando você cria um grupo de endpoints para uma instância de listener HTTP ou HTTPS. Para uma instância de listener HTTP, o protocolo do serviço de backend suporta apenas HTTP.	HTTP
EndpointProtocolVersion	string	Não	A versão do protocolo do serviço de backend. Valores válidos: HTTP1.1 HTTP2 Nota Você pode especificar a versão do protocolo do serviço de backend apenas quando o parâmetro EndpointRequestProtocol estiver definido como HTTPS.	HTTP1.1
PortOverrides	array<object>	Não	Os mapeamentos de porta.
	object	Não	Os mapeamentos de porta.
ListenerPort	integer	Não	A porta do listener no mapeamento de porta. Nota Para listeners TCP: mapeamentos de porta não são suportados para grupos de endpoints virtuais. Se um grupo de endpoints virtual já existir no listener, você não poderá configurar mapeamentos de porta para o grupo de endpoints padrão. Se os mapeamentos de porta já estiverem configurados para o grupo de endpoints padrão, você não poderá adicionar um grupo de endpoints virtual. Após configurar os mapeamentos de porta, os seguintes limites se aplicam às modificações subsequentes do listener: você não pode modificar o protocolo do listener, exceto para alternar entre HTTP e HTTPS. Porta do listener: o intervalo de portas do listener modificado deve incluir todas as portas do listener nos mapeamentos de porta atuais. Por exemplo, se o intervalo de portas do listener for de 80 a 82 e os mapeamentos de porta estiverem configurados para mapear para as portas de endpoint de 100 a 102, você não poderá alterar o intervalo de portas do listener para 80 a 81.	443
EndpointPort	integer	Não	A porta do endpoint no mapeamento de porta.	80
HealthCheckEnabled	boolean	Não	Especifica se os health checks devem ser ativados. Valores válidos: true: ativa os health checks. false (padrão): desativa os health checks.	true
HealthCheckHost	string	Não	O nome de domínio usado para health checks.	www.taobao.com
EndpointIpVersion	string	Não	A versão do IP do endereço IP de backend. Valores válidos: IPv4 (padrão): o GA se comunica com o serviço de endpoint apenas por IPv4. IPv6: o GA se comunica com o serviço de endpoint apenas por IPv6. ProtocolAffinity: o GA se comunica com o serviço de endpoint pela mesma versão de IP da solicitação do cliente.	IPv4
ProxyTunnel	object	Não	As configurações do túnel de proxy.
ConnectAuthPrefix	string	Não	O prefixo para autenticação de conexão do túnel de proxy.	prefix-auth
ConnectAuthSuffix	string	Não	O sufixo para autenticação de conexão do túnel de proxy.	suffix-auth
ConnectSessionHashHdr	string	Não	O cabeçalho de hash da sessão de conexão.	X-Session-Hash
ConnectTunnelTimeout	integer	Não	O tempo limite de conexão para o túnel de proxy.	5000
TunnelServerPort	integer	Não	A porta do servidor de túnel.	8443
TunnelServerType	string	Não	O tipo de servidor de túnel.	domain
TunnelServer	string	Não	O endereço do servidor do túnel de proxy.	tunnel.example.com
HealthCheckMethod	string	Não	O método de health check.	GET
HealthCheckSuccessCodes	string	Não	Os códigos de status de sucesso para health checks.	http_2xx,http_3xx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações retornadas.
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
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
400	NotExist.EndPointGroup	The endpoint group does not exist.
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.
400	NotExist.Listener	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.
400	NotExist.Accelerator	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	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.