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

Modifica grupos de endpoints para um listener em lote.

Descrição da operação

Notas de uso

UpdateEndpointGroups é uma operação assíncrona. Após o envio de uma solicitação, o sistema retorna um ID de solicitação, mas a operação continua sendo executada em segundo plano. Você pode chamar a operação para consultar o estado de um grupo de endpoints.
- Se um grupo de endpoints estiver no estado updating, sua configuração está sendo modificada. Nesse estado, você só pode realizar operações de consulta.
- Se um grupo de endpoints estiver no estado active, sua configuração foi modificada.
Você não pode chamar simultaneamente a operação UpdateEndpointGroups para modificar as configurações de grupos de endpoints que pertencem à 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:UpdateEndpointGroups

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 GA. Defina o valor como cn-hangzhou.	cn-hangzhou
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Gere um valor para este parâmetro no seu cliente. Certifique-se de que o valor seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação como o ClientToken. O RequestId pode ser diferente para cada solicitação.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run. O sistema verifica os parâmetros obrigatórios, o formato da solicitação e os limites do serviço. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado. false (padrão): envia a solicitação. Se a solicitação passar na verificação, um código de status HTTP 2xx será retornado e a operação será executada.	true
EndpointGroupConfigurations	array<object>	Sim	As configurações do grupo de endpoints.
	array<object>	Não	As configurações do grupo de endpoints.
EndpointGroupName	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 letras, dígitos, pontos (.), underscores (_) e hifens (-).	group1
EndpointGroupDescription	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://.	group1
TrafficPercentage	integer	Não	A proporção de distribuição de tráfego. Se um listener estiver associado a vários grupos de endpoints, você pode especificar este parâmetro para distribuir o tráfego entre os grupos de endpoints. Valores válidos: 1 a 100.	20
HealthCheckEnabled	boolean	Não	Especifica se o recurso de verificação de integridade deve ser ativado. true: ativa o recurso de verificação de integridade. false (padrão): desativa o recurso de verificação de integridade.	true
HealthCheckIntervalSeconds	integer	Não	O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Valores válidos: 1 a 50.	3
HealthCheckPath	string	Não	O caminho da verificação de integridade.	/healthcheck
HealthCheckPort	integer	Não	A porta usada para verificações de integridade. Valores válidos: 1 a 65535.	20
HealthCheckProtocol	string	Não	O protocolo usado para verificações de integridade. tcp ou TCP: TCP http ou HTTP: HTTP https ou HTTPS: HTTPS	tcp
ThresholdCount	integer	Não	O número de verificações de integridade consecutivas que um endpoint deve passar para ser considerado íntegro, ou falhar para ser considerado não íntegro. Valores válidos: 2 a 10.	3
EndpointConfigurations	array<object>	Não	As configurações do endpoint.
	object	Sim	As configurações do endpoint.
Type	string	Sim	O tipo do endpoint. 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 do Alibaba Cloud Elastic Compute Service (ECS). SLB: uma instância do Alibaba Cloud Server Load Balancer (SLB). ALB: uma instância do Alibaba Cloud Application Load Balancer (ALB). OSS: um bucket do Alibaba Cloud Object Storage Service (OSS). ENI: uma Elastic Network Interface (ENI) do Alibaba Cloud. NLB: uma instância do Alibaba Cloud Network Load Balancer (NLB). Nota Se você definir o tipo de endpoint como ECS, ENI, SLB, NLB 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 você definir o tipo de endpoint como 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 você definir o tipo de endpoint como 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. Nota Para mais informações, consulte .	Ip
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 GA deixará de distribuir tráfego para o endpoint. Trate isso com cuidado.	20
Endpoint	string	Sim	O endereço IP, nome de domínio ou ID da instância do endpoint, com base no valor de Type.	47.0.XX.XX
SubAddress	string	Não	O endereço IP privado da ENI. Nota Este parâmetro está disponível apenas quando o tipo de endpoint é ENI. Você pode especificar este parâmetro. Se você não especificar este parâmetro, o endereço IP privado principal da ENI será usado.	172.168.XX.XX
EnableClientIPPreservation	boolean	Não	Especifica se os endereços IP do cliente devem ser preservados. Valores válidos: true: preserva os endereços IP do cliente. false (padrão): não preserva os endereços IP do cliente. Nota Por padrão, a preservação de endereço IP do cliente está desativada para grupos de endpoints de listeners TCP e UDP. Você pode ativá-la conforme suas necessidades de negócio. A preservação de endereço IP do cliente está ativada por padrão para grupos de endpoints de listeners HTTP e HTTPS. Os endereços IP do cliente são obtidos do campo de cabeçalho X-Forwarded-For. Você não pode desativar este recurso. EnableClientIPPreservation e EnableProxyProtocol não podem ser definidos como true ao mesmo tempo. Para mais informações, consulte .
EnableProxyProtocol	boolean	Não	Especifica se o Proxy Protocol deve ser usado para preservar os endereços IP do cliente. Valores válidos: true: usa o Proxy Protocol. false (padrão): não usa o Proxy Protocol. Nota Este parâmetro está disponível apenas para grupos de endpoints de listeners TCP. EnableClientIPPreservation e EnableProxyProtocol não podem ser definidos como true ao mesmo tempo. Para mais informações, consulte .
VpcId	string	Não	O ID da virtual private cloud (VPC). Você pode especificar no máximo um ID de VPC para um grupo de endpoints associado a um listener que usa roteamento inteligente. Nota Este parâmetro é obrigatório e tem efeito apenas quando o tipo de endpoint é IpTarget.	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	Não	A lista de vSwitches na VPC.
	string	Não	The ID of the vSwitch. You can specify at most two vSwitch IDs for an endpoint group that is associated with a listener that uses smart routing. Nota This parameter is required and takes effect only when the endpoint type is IpTarget. The vSwitch must belong to the VPC specified by the VpcId parameter.	vsw-uf6r0due94mypz1i9****
Provider	string	Não		BAILIAN
ApiKeys	array	Não
	string	Não		sk-*******
EndpointRequestProtocol	string	Não	O protocolo do serviço de backend. Valores válidos: HTTP: HTTP HTTPS: HTTPS Nota Você pode definir este parâmetro apenas ao criar um grupo de endpoints para um listener HTTP ou HTTPS. Para um listener HTTP, o protocolo do serviço de backend deve ser HTTP.	HTTP
EndpointProtocolVersion	string	Não	A versão do protocolo do serviço de backend para endpoints em um listener que usa roteamento inteligente. Valores válidos: HTTP1.1 (padrão): HTTP/1.1 HTTP2: HTTP/2 Nota Este parâmetro está disponível apenas quando você define EndpointRequestProtocol como HTTPS.	HTTP1.1
PortOverrides	array<object>	Não	O mapeamento de portas.
	object	Não	O mapeamento de portas.
ListenerPort	integer	Não	A porta do listener. Valores válidos: 1 a 65499. Nota Para listeners TCP, grupos de endpoints virtuais não suportam mapeamento de portas. Se um grupo de endpoints virtual já existir sob o listener, você não poderá configurar o mapeamento de portas para o grupo de endpoints padrão. Se o mapeamento de portas já estiver configurado para o grupo de endpoints padrão, você não poderá adicionar um grupo de endpoints virtual. Após configurar o mapeamento de portas, os seguintes limites se aplicam a modificações subsequentes do listener: Você não pode alterar o protocolo do listener, exceto para alterá-lo entre HTTP e HTTPS. Porta do listener: O intervalo de portas do listener modificado deve incluir todas as portas do listener que estão atualmente mapeadas. Por exemplo, se o intervalo de portas do listener for 80-82 e as portas estiverem mapeadas para as portas de endpoint 100-102, você não poderá alterar o intervalo de portas do listener para 80-81.	443
EndpointPort	integer	Não	A porta do endpoint. Valores válidos: 1 a 65499.	80
EnableClientIPPreservationToa	boolean	Não	Especifica se o módulo TCP Option Address (TOA) deve ser usado para preservar os endereços IP do cliente. Valores válidos: true: sim. false: não.	false
EnableClientIPPreservationProxyProtocol	boolean	Não	Especifica se o Proxy Protocol deve ser usado para preservar os endereços IP do cliente. Valores válidos: true: sim. false: não.	false
EndpointGroupId	string	Sim	O ID do grupo de endpoints.	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	string	Não
EndpointIpVersion	string	Não
ListenerId	string	Sim	O ID do listener.	lsr-bp1bpn0kn908w4nbw****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	Os IDs dos grupos de endpoints.
	string	O ID do grupo de endpoints.	epg-bp1dmlohjjz4kqaun****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaun****"
  ]
}

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.