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

Cria uma lista de grupos de endpoints.

Descrição da operação

Você pode invocar esta operação para criar grupos de endpoints em lotes. No entanto, não é possível criar grupos de endpoints padrão e grupos de endpoints virtuais ao mesmo tempo.
Esta operação não oferece suporte à criação de um grupo de endpoints virtual para listeners de protocolo da camada 4. Para criar um grupo de endpoints virtual para um listener de protocolo da camada 4, use CreateEndpointGroup.
A operação CreateEndpointGroups é assíncrona. O sistema retorna um ID de solicitação, mas os grupos de endpoints não são criados imediatamente. O nó de criação no sistema em segundo plano ainda está em andamento. Você pode invocar DescribeEndpointGroup ou ListEndpointGroups para consultar o status dos grupos de endpoints:
- Se um grupo de endpoints estiver no estado init, os grupos de endpoints estão sendo criados em lotes. Neste estado, você pode realizar apenas operações de consulta.
- Se todos os grupos de endpoints estiverem no estado active, os grupos de endpoints foram criados.
A operação CreateEndpointGroups não oferece suporte a operações simultâneas para criar um grupo de endpoints na mesma instância do Alibaba Cloud 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:CreateEndpointGroups

create

*EndpointGroup.

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

*Accelerator.

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

*Listener.

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

ga:AcceleratorMainland

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 Alibaba Cloud 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 usar o cliente para gerar o valor, mas deve garantir que ele seja exclusivo entre diferentes solicitações. O token de cliente 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 de cada solicitação de API é exclusivo.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	Não	Especifica se deve ser realizada apenas uma pré-verificação da solicitação. Valores válidos: true: pré-verifica a solicitação sem criar o recurso. O sistema verifica se os parâmetros obrigatórios foram especificados, o formato da solicitação e os limites do serviço. Se a solicitação falhar na pré-verificação, o erro correspondente será retornado. Se a solicitação passar na pré-verificação, um código de status HTTP 2xx será retornado. false (padrão): envia a solicitação. Se a solicitação passar na pré-verificação, um código de status HTTP 2xx será retornado e a operação será executada.	true
AcceleratorId	string	Sim	O ID da instância do Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	Sim	O ID do listener. Nota Se o protocolo do listener for HTTP ou HTTPS, você poderá criar apenas um grupo de endpoints cada vez que chamar a operação CreateEndpointGroups.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	Sim	As configurações do grupo de endpoints. Você pode especificar até 10 grupos de endpoints.
	array<object>	Não	As configurações do grupo de endpoints. Você pode especificar até 10 grupos de endpoints.
EndpointGroupName	string	Não	O nome do grupo de endpoints. O nome deve ter de 1 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra ou caractere chinês.	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://.	EndpointGroup
EndpointGroupRegion	string	Sim	O ID da região do grupo de endpoints. Você pode especificar até 10 IDs de região.	cn-hongkong
TrafficPercentage	integer	Não	A proporção de distribuição de tráfego. Quando um listener usa roteamento inteligente e possui vários grupos de endpoints, este parâmetro especifica a proporção de tráfego distribuído para cada grupo de endpoints. Valores válidos: 1 a 100. Valor padrão: 100. Você pode especificar a proporção de distribuição de tráfego para até 10 grupos de endpoints.	100
HealthCheckEnabled	boolean	Não	Especifica se as verificações de integridade devem ser ativadas para o grupo de endpoints de um listener que usa roteamento inteligente. Valores válidos: true: ativa as verificações de integridade. false (padrão): desativa as verificações de integridade. Você pode ativar verificações de integridade para até 10 grupos de endpoints.	false
HealthCheckIntervalSeconds	integer	Não	O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Você pode especificar o intervalo de verificação de integridade para até 10 grupos de endpoints.	5
HealthCheckPath	string	Não	O caminho de verificação de integridade. Você pode especificar o caminho de verificação de integridade para até 10 grupos de endpoints.	/healthcheck
HealthCheckPort	integer	Não	A porta de verificação de integridade. Valores válidos: 1 a 65535. Você pode especificar a porta de verificação de integridade para até 10 grupos de endpoints.	443
HealthCheckProtocol	string	Não	O protocolo de verificação de integridade. Valores válidos: tcp ou TCP: TCP http ou HTTP: HTTP https ou HTTPS: HTTPS Você pode especificar o protocolo de verificação de integridade para até 10 grupos de endpoints.	HTTPS
ThresholdCount	integer	Não	O número de verificações de integridade consecutivas que devem ser bem-sucedidas ou falhar antes que o status da verificação de integridade mude. Especificamente, este é o número de verificações de integridade com falha consecutivas necessárias para alterar o status de íntegro para não íntegro, ou o número de verificações de integridade bem-sucedidas consecutivas necessárias para alterar o status de não íntegro para íntegro. Valores válidos: 2 a 10. Valor padrão: 3. Você pode especificar o limite para até 10 grupos de endpoints.	3
EndpointConfigurations	array<object>	Não	As configurações de endpoint para um listener que usa roteamento inteligente.
	object	Não	As configurações de endpoint para um listener que usa roteamento inteligente.
Type	string	Não	O tipo de endpoint para um listener que usa roteamento inteligente. Valores válidos: Domain: nome de domínio personalizado Ip: endereço IP personalizado IpTarget: IP privado personalizado PublicIp: endereço IP público do Alibaba Cloud ECS: instância ECS SLB: instância do Server Load Balancer (SLB) ALB: instância do Application Load Balancer (ALB) OSS: instância do Object Storage Service (OSS) ENI: controlador de interface de rede elástica (NIC) do Alibaba Cloud NLB: instância do Network Load Balancer (NLB) Você pode especificar até 100 endpoints em um grupo de endpoints de um listener que usa roteamento inteligente. Nota Quando Type (tipo de roteamento do listener) é definido como Standard (roteamento inteligente), você pode configurar o grupo de endpoints e as informações do endpoint para o listener, e este parâmetro é obrigatório. Se o tipo de endpoint for definido como ECS, ENI, SLB, ALB, NLB ou IpTarget, e a função de associado de serviço não existir, o sistema criará automaticamente uma função de associado de serviço chamada AliyunServiceRoleForGaVpcEndpoint. Se o tipo de endpoint for definido como ALB, e a função de associado de serviço não existir, o sistema criará automaticamente uma função de associado de serviço chamada AliyunServiceRoleForGaAlb. Se o tipo de endpoint for definido como OSS, e a função de associado de serviço não existir, o sistema criará automaticamente uma função de associado de serviço chamada AliyunServiceRoleForGaOss. Se o tipo de endpoint for definido como NLB, e a função de associado de serviço não existir, o sistema criará automaticamente uma função de associado de serviço chamada AliyunServiceRoleForGaNlb. Nota Para mais informações, consulte Funções de associado de serviço.	Domain
Weight	integer	Não	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.	255
Endpoint	string	Não	O endereço IP ou nome de domínio do endpoint para um listener que usa roteamento inteligente. Você pode especificar até 100 endereços IP ou nomes de domínio em um grupo de endpoints de um listener que usa roteamento inteligente.	1.1.1.1
SubAddress	string	Não	O IP privado do controlador de interface de rede elástica (NIC). Nota Se o tipo de endpoint for ENI, você poderá configurar este parâmetro. Se você não configurar este parâmetro, o IP privado principal do controlador de interface de rede elástica (NIC) será usado por padrão.	172.168.XX.XX
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 de listeners UDP ou TCP. Você pode configurar este parâmetro 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 de listeners HTTP ou HTTPS. Os endereços IP do cliente são recuperados usando o campo de cabeçalho X-Forwarded-For. Você não pode desativar esse recurso. EnableClientIPPreservation e EnableProxyProtocol não podem ser definidos como true ao mesmo tempo. Para mais informações, consulte Preservar endereços IP de cliente.	false
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 de listeners TCP. EnableClientIPPreservation e EnableProxyProtocol não podem ser definidos como true ao mesmo tempo. Para mais informações, consulte Preservar endereços IP de cliente.	false
VpcId	string	Não	O ID da VPC. Você pode especificar apenas um ID de VPC em um grupo de endpoints de um listener que usa roteamento inteligente. Nota Este parâmetro é válido e obrigatório apenas quando o tipo de endpoint é IpTarget.	vpc-2zekzii824szm3hps****
VSwitchIds	array	Não	Os vSwitches na VPC.
	string	Não	O ID do vSwitch. Você pode especificar até dois IDs de vSwitch em um grupo de endpoints de um listener que usa roteamento inteligente. Nota Este parâmetro é válido e obrigatório apenas quando o tipo de endpoint é IpTarget. O vSwitch deve pertencer à VPC especificada pelo parâmetro VpcId.	vsw-bp1b2qx7y2qqnbkan****
Provider	string	Não	A configuração do provedor.	BAILIAN
ApiKeys	array	Não	As chaves de API na configuração do grupo de endpoints.
	string	Não	As chaves de API na configuração do grupo de endpoints.	sk-******
EndpointRequestProtocol	string	Não	O protocolo do serviço de back-end. Valores válidos: HTTP: HTTP HTTPS: 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 back-end deve ser HTTP.	HTTPS
EndpointProtocolVersion	string	Não	A versão do protocolo do serviço de back-end para o endpoint de um listener que usa roteamento inteligente. Valores válidos: HTTP1.1 (padrão): HTTP/1.1 HTTP2: HTTP/2 Nota Você pode especificar a versão do protocolo do serviço de back-end apenas quando o parâmetro EndpointRequestProtocol (protocolo do serviço de back-end) estiver definido como HTTPS.	HTTP1.1
EndpointGroupType	string	Não	O tipo de grupo de endpoints para um listener que usa roteamento inteligente. Valores válidos: default (padrão): grupo de endpoints padrão virtual: grupo de endpoints virtual Você pode especificar até 10 tipos de grupo de endpoints.	default
PortOverrides	array<object>	Não	Os mapeamentos de porta.
	object	Não	Os mapeamentos de porta.
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 mapeamentos de porta. Se um grupo de endpoints virtual já existir no listener, o grupo de endpoints padrão não poderá ser configurado com mapeamentos de porta. Se o grupo de endpoints padrão já estiver configurado com mapeamentos de porta, você não poderá adicionar um grupo de endpoints virtual. Após a configuração dos 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 atualmente configuradas nos mapeamentos de porta. Por exemplo, se o intervalo de portas do listener for 80-82 e os mapeamentos de porta estiverem configurados para as portas de endpoint 100-102, você não poderá alterar o intervalo de portas do listener para 80-81 posteriormente.	80
EndpointPort	integer	Não	A porta do endpoint para mapeamento de porta.	443
Tag	array<object>	Não	As tags do grupo de endpoints.
	object	Não	As tags do grupo de endpoints.
Key	string	Não	A chave da tag do grupo de endpoints. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`. Você pode especificar até 20 chaves de tag.	tag-key
Value	string	Não	O valor da tag do grupo de endpoints. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`. Você pode especificar até 20 valores de tag.	tag-value
SystemTag	array<object>	Não	Este parâmetro não é usado. Você não precisa configurá-lo.
	object	Não	Este parâmetro não é usado. Você não precisa configurá-lo.
Key	string	Não	Este parâmetro não é usado. Você não precisa configurá-lo.	-
Value	string	Não	Este parâmetro não é usado. Você não precisa configurá-lo.	-
Scope	string	Não	Este parâmetro não é usado. Você não precisa configurá-lo.	-
HealthCheckHost	string	Não	O nome de domínio para verificações de integridade.	www.taobao.com
EndpointIpVersion	string	Não	A versão do IP do serviço de back-end. 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	A configuração do túnel de proxy.
ConnectAuthPrefix	string	Não	O prefixo de autenticação de conexão do túnel de proxy.	prefix-auth
ConnectAuthSuffix	string	Não	O sufixo de autenticação de conexão do túnel de proxy.	suffix-auth
ConnectSessionHashHdr	string	Não	A configuração do cabeçalho de hash da sessão de conexão.	X-Session-Hash
ConnectTunnelTimeout	integer	Não	O período de tempo limite de conexão do 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	A configuração do servidor de túnel.	tunnel.example.com
HealthCheckMethod	string	Não	O método de verificação de integridade.	GET

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
EndpointGroupIds	array	A lista de IDs de grupos de endpoints.
	string	A lista de IDs de grupos 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
400	Domain.NotFit	The domain is not fit the rule
400	Resource.QuotaFull	The resource quota is exceeded.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
400	NotSupportHealthCheck.Accelerator	Currently Accelerator does not support health check.
400	EndpointGroupExclusive.Listener	All endpoint group must under the same listener.
400	RegionConflict.EndpointGroup	Endpoint group under the same listener must have different region.
400	ListenerProtocolIllegal.EndpointGroup	Listener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.
400	ParamExclusive.EndpointGroupType	All endpoint group type group must be consistent.
400	HealthCheckPath.Illegal	Health check path illegal.
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	NotExist.BusinessRegion	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.
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
400	MixedVpc.EndPoint	VPC Endpoint cannot be mixed with other types of Endpoints.
400	IllegalPublicIp.EndPoint	The public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.