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

Cria grupos de endpoints em lotes.

Descrição da operação

Cria grupos de endpoints em lotes. Grupos de endpoints padrão e virtuais não podem ser criados em uma única chamada.
Esta API não oferece suporte à criação de grupos de endpoints virtuais para listeners da Camada 4. Para criar um grupo de endpoints virtual para um listener da Camada 4, chame CreateEndpointGroup.
CreateEndpointGroups é uma API assíncrona. Ela retorna um ID de solicitação e cria os grupos de endpoints em segundo plano. Você pode chamar DescribeEndpointGroup ou ListEndpointGroups para consultar o status de um grupo de endpoints:
- Se um grupo de endpoints estiver no estado init, ele está sendo inicializado. Você só pode consultar o grupo de endpoints neste estado.
- A criação em lote é concluída quando todos os grupos de endpoints estão no estado active.
Você não pode fazer chamadas simultâneas para CreateEndpointGroups para a mesma instância do Global Accelerator.

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 onde o acelerador está implantado. 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 ele seja exclusivo em diferentes solicitações. O valor de `ClientToken` 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 é exclusivo para cada solicitação de API.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run, mas não cria o recurso. 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, o sistema retorna uma mensagem de erro. Se a solicitação passar no dry run, o sistema retorna um código de status HTTP 2xx. false (padrão): envia uma solicitação normal e cria o recurso se a solicitação for aprovada.	true
AcceleratorId	string	Sim	O ID do acelerador.	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 em cada chamada de CreateEndpointGroups.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	Sim	As configurações dos grupos de endpoints. Você pode configurar até 10 grupos de endpoints.
	array<object>	Não	A configuração de um 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 conter dígitos, pontos (.), sublinhados (_) 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://`.	EndpointGroup
EndpointGroupRegion	string	Sim	O ID da região onde o grupo de endpoints está implantado. Você pode inserir até 10 IDs de região de grupo de endpoints.	cn-hongkong
TrafficPercentage	integer	Não	A porcentagem de distribuição de tráfego para o grupo de endpoints. Se um listener de roteamento inteligente estiver associado a vários grupos de endpoints, este parâmetro especifica a porcentagem de tráfego que é roteada para este grupo de endpoints. Valores válidos: 1 a 100. Valor padrão: 100. Você pode inserir valores de ajuste 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. 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 as verificações de integridade, em segundos. Você pode inserir até 10 intervalos de verificação de integridade.	5
HealthCheckPath	string	Não	O caminho usado para as verificações de integridade. Você pode inserir até 10 caminhos de verificação de integridade.	/healthcheck
HealthCheckPort	integer	Não	A porta usada para as verificações de integridade. Valores válidos: 1 a 65535. Você pode inserir até 10 portas para verificações de integridade.	443
HealthCheckProtocol	string	Não	O protocolo usado para as verificações de integridade. Valores válidos: tcp ou TCP: protocolo TCP. http ou HTTP: protocolo HTTP. https ou HTTPS: protocolo HTTPS. Você pode inserir até 10 protocolos de verificação de integridade.	HTTPS
ThresholdCount	integer	Não	O número de verificações de integridade consecutivas que devem ser bem-sucedidas para que um endpoint seja considerado íntegro, ou falhar para que seja considerado não íntegro. Valores válidos: 2 a 10. Valor padrão: 3. Você pode inserir até 10 valores para o número de verificações de integridade consecutivas necessárias para uma alteração de status de integridade.	3
EndpointConfigurations	array<object>	Não	As configurações dos endpoints no grupo de endpoints.
	object	Não	A configuração de um endpoint.
Type	string	Não	O tipo de endpoint em um listener de roteamento inteligente. 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: um bucket do OSS. ENI: uma interface de rede elástica. NLB: uma instância NLB. Em um grupo de endpoints de um listener de roteamento inteligente, você pode especificar até 100 endpoints. Nota Se o tipo de roteamento do listener for Standard (roteamento inteligente), você deverá configurar o grupo de endpoints e as informações do endpoint para o listener. Este parâmetro é obrigatório. Se você definir Type como ECS, ENI, SLB ou IpTarget e não existir uma função vinculada ao serviço, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaVpcEndpoint. Se você definir Type como ALB e não existir uma função vinculada ao serviço, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaAlb. Se você definir Type como OSS e não existir uma função vinculada ao serviço, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaOss. Se você definir Type como NLB e não existir uma função vinculada ao serviço, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaNlb. Nota Para mais informações, consulte funções vinculadas ao serviço.	Domain
Weight	integer	Não	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.	255
Endpoint	string	Não	O endereço IP ou nome de domínio do endpoint. Em um grupo de endpoints de um listener de roteamento inteligente, você pode inserir no máximo 100 endereços IP ou nomes de domínio de endpoints.	1.1.1.1
SubAddress	string	Não	O endereço IP privado da interface de rede elástica (ENI). Nota Este parâmetro está disponível apenas quando o tipo de endpoint é ENI. Se você não especificar este parâmetro, o sistema usará o endereço IP privado principal da ENI.	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 Para grupos de endpoints de listeners UDP e TCP, o recurso de preservação de IP do cliente é desativado por padrão. Você pode ativar esse recurso com base nos requisitos do seu negócio. Para grupos de endpoints de listeners HTTP e HTTPS, o recurso de preservação de IP do cliente é ativado por padrão. Os endereços IP do cliente são preservados no 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 do cliente.	false
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 para preservar os endereços IP do cliente. false (padrão): não usa o Proxy Protocol para preservar os endereços IP do cliente. Nota Este parâmetro está disponível apenas para grupos de endpoints associados a listeners TCP. `EnableClientIPPreservation` e `EnableProxyProtocol` não podem ser definidos como `true` ao mesmo tempo. Para mais informações, consulte preservar endereços IP do cliente.	false
VpcId	string	Não	O ID da VPC. Em um grupo de endpoints de um listener de roteamento inteligente, você pode especificar apenas um ID de VPC. Nota Este parâmetro é obrigatório apenas quando você define Type como IpTarget.	vpc-2zekzii824szm3hps****
VSwitchIds	array	Não	Uma lista de IDs de VSwitch.
	string	Não	The ID of the VSwitch. In an endpoint group of an intelligent routing listener, you can specify up to two VSwitch IDs. Nota This parameter is required and applies only when the endpoint type is IpTarget. The VSwitch must be in the VPC specified by the VpcId parameter.	vsw-bp1b2qx7y2qqnbkan****
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 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, você pode definir este parâmetro apenas como HTTP.	HTTPS
EndpointProtocolVersion	string	Não	A versão do protocolo do serviço de backend. Valores válidos: HTTP1.1 (padrão): HTTP 1.1. HTTP2: HTTP 2. Nota Você pode definir este parâmetro apenas quando `EndpointRequestProtocol` estiver definido como HTTPS.	HTTP1.1
EndpointGroupType	string	Não	O tipo do grupo de endpoints em um listener de roteamento inteligente. Valores válidos: default (padrão): um grupo de endpoints padrão. virtual: um grupo de endpoints virtual. Você pode inserir até 10 tipos de grupo de endpoints.	default
PortOverrides	array<object>	Não	As configurações de substituição de porta.
	object	Não	Uma configuração de substituição de porta.
ListenerPort	integer	Não	A porta do listener. Valores válidos: 1 a 65499. Nota Para listeners TCP, você não pode configurar substituições de porta para um grupo de endpoints virtual. Se já existir um grupo de endpoints virtual para o listener, você não poderá configurar substituições de porta para o grupo de endpoints padrão. Se as substituições de porta estiverem configuradas para o grupo de endpoints padrão, você não poderá adicionar um grupo de endpoints virtual. Depois de configurar uma substituição de porta, você não poderá alterar o protocolo do listener, exceto para alternar entre HTTP e HTTPS. Ao modificar o intervalo de portas do listener, o novo intervalo deve incluir todas as portas do listener usadas nas substituições de porta. Por exemplo, se o intervalo de portas do listener for 80-82 e uma substituição de porta estiver configurada para mapear as portas do listener para as portas do endpoint 100-102, você não poderá alterar o intervalo de portas do listener para 80-81.	80
EndpointPort	integer	Não	A porta do endpoint usada para a substituição de porta.	443
Tag	array<object>	Não	As tags a serem adicionadas ao grupo de endpoints. Você pode especificar até 20 tags.
	object	Não	As tags do grupo de endpoints.
Key	string	Não	A chave da tag. 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 inserir até 20 chaves de tag.	tag-key
Value	string	Não	O valor da tag. 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 inserir até 20 valores de tag.	tag-value
SystemTag	array<object>	Não	Este parâmetro é reservado.
	object	Não	Este parâmetro é reservado.
Key	string	Não	Este parâmetro é reservado.	-
Value	string	Não	Este parâmetro é reservado.	-
Scope	string	Não	Este parâmetro é reservado.	-
HealthCheckHost	string	Não	O nome de domínio para o qual as solicitações de verificação de integridade são enviadas.	www.taobao.com
EndpointIpVersion	string	Não	A versão de IP do serviço de backend. Valores válidos: IPv4 (padrão): o Global Accelerator usa apenas endereços IPv4 para se comunicar com o serviço de backend. IPv6: o Global Accelerator usa apenas endereços IPv6 para se comunicar com o serviço de backend. ProtocolAffinity: o Global Accelerator se comunica com o serviço de backend usando a mesma versão de IP da solicitação do cliente.	IPv4

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	Os IDs dos grupos de endpoints.
	string	O ID de um 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	Domain.NotFit	The domain is not fit the rule	The domain name does not have an ICP number.
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
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	NotSupportHealthCheck.Accelerator	Currently Accelerator does not support health check.	The current GA instance does not support health checks.
400	EndpointGroupExclusive.Listener	All endpoint group must under the same listener.	All the endpoint groups must be associated with the same listener.
400	RegionConflict.EndpointGroup	Endpoint group under the same listener must have different region.	The endpoint groups that are associated with the same listener must be deployed in different regions.
400	ListenerProtocolIllegal.EndpointGroup	Listener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.	You can configure only one default endpoint group for an HTTPS or HTTP listener.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.	The number of endpoint groups has reached the upper limit.
400	ParamExclusive.EndpointGroupType	All endpoint group type group must be consistent.
400	HealthCheckPath.Illegal	Health check path illegal.	The health check path is invalid.
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	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
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
400	MixedVpc.EndPoint	VPC Endpoint cannot be mixed with other types of Endpoints.	You cannot use private endpoints 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.	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.