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

Cria um grupo de endpoints.

Descrição da operação

Ao chamar esta operação para criar um grupo de endpoints virtual para um listener da Camada 4, certifique-se de que um grupo de endpoints padrão foi criado.
CreateEndpointGroup é uma operação assíncrona. Após chamar esta operação, o sistema retorna um ID de grupo de endpoints, mas o grupo de endpoints ainda não foi criado e a tarefa de criação ainda está sendo executada em segundo plano. Você pode chamar DescribeEndpointGroup para consultar o status do grupo de endpoints:
- Quando o grupo de endpoints está no estado init, o grupo de endpoints está sendo criado. Neste estado, você pode realizar apenas operações de consulta.
- Quando o grupo de endpoints está no estado active, o grupo de endpoints foi criado.
Você não pode chamar a operação CreateEndpointGroup para criar grupos de endpoints simultaneamente para a 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:CreateEndpointGroup

create

*EndpointGroup.

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

*Listener.

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

*Accelerator.

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

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 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 o valor seja exclusivo entre diferentes solicitações. O token de cliente pode conter apenas caracteres ASCII. Nota Se você não definir 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.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Sim	O ID da instância do Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
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	string	Sim	O ID da região do grupo de endpoints.	cn-hangzhou
ListenerId	string	Sim	O ID do listener.	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	Não	A porcentagem de tráfego distribuída para o grupo de endpoints quando o listener possui vários grupos de endpoints. Valores válidos: 1 a 100.	20
HealthCheckIntervalSeconds	integer	Não	O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos.	3
HealthCheckPath	string	Não	O caminho da verificação de integridade.	/healthcheck
HealthCheckPort	integer	Não	A porta da verificação de integridade.	20
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.	tcp
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 de sucesso para falha ou de falha para sucesso. Valores válidos: 2 a 10. Valor padrão: 3.	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: nome de domínio personalizado. Ip: endereço IP personalizado. IpTarget: endereço IP privado personalizado. PublicIp: endereço IP público da Alibaba Cloud. ECS: instância ECS. SLB: instância do Classic Load Balancer (CLB). 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) da Alibaba Cloud. NLB: instância do Network Load Balancer (NLB). Nota Se o tipo de endpoint estiver definido como ECS, ENI, SLB, ALB, 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 o tipo de endpoint estiver definido 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 o tipo de endpoint estiver definido 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. Se o tipo de endpoint estiver definido como 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 mais informações, consulte Funções vinculadas ao serviço.	Ip
EnableClientIPPreservation	boolean	Não	Especifica se deve ativar a preservação do endereço IP do cliente 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 que correspondem 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 que correspondem a 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. Você não pode definir EnableClientIPPreservation e EnableProxyProtocol como true simultaneamente. Para mais informações, consulte Preservar endereços IP de 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 deve ativar a preservação do endereço IP do cliente 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 que correspondem a listeners TCP. Você não pode definir EnableClientIPPreservation e EnableProxyProtocol como true simultaneamente. Para mais informações, consulte Preservar endereços IP de cliente.	false
Endpoint	string	Sim	O endereço IP, nome de domínio ou ID da instância do endpoint. Especifique o valor com base no tipo de endpoint.	120.1.XX.XX
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 é ENI. Se você não definir este parâmetro, o endereço IP privado principal do controlador de interface de rede elástica (NIC) será usado por padrão.	172.168.X.X
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 de um listener de roteamento inteligente. Nota Este parâmetro é obrigatório e entra em vigor apenas quando o tipo de endpoint é IpTarget.	vpc-bp1quce3451z5b2hv****
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 de um listener de roteamento inteligente. Nota Este parâmetro é obrigatório e entra em vigor apenas quando o tipo de endpoint é IpTarget. O vSwitch deve pertencer à VPC especificada pelo parâmetro VpcId.	vsw-bp12mho4ze51ezagm****
Provider	string	Não	O provedor de serviços na configuração do endpoint.	BAILIAN
ApiKeys	array	Não	As chaves de API na configuração do endpoint.
	string	Não	A primeira chave de API na configuração do endpoint.	sk-***********
EndpointRequestProtocol	string	Não	O protocolo de serviço de back-end. Valores válidos: HTTP (padrão) HTTPS Nota Este parâmetro é suportado apenas quando você cria um grupo de endpoints para um listener HTTP ou HTTPS. Para um listener HTTP, o protocolo de serviço de back-end pode ser apenas HTTP.	HTTP
EndpointProtocolVersion	string	Não	A versão do protocolo de serviço de back-end. Valores válidos: HTTP1.1 (padrão): HTTP/1.1. HTTP2: HTTP/2. Nota Você pode especificar a versão do protocolo de serviço de back-end apenas quando o parâmetro EndpointRequestProtocol estiver definido como HTTPS.	HTTP1.1
EndpointGroupType	string	Não	O tipo de grupo de endpoints. Valores válidos: default (padrão): grupo de endpoints padrão. virtual: grupo de endpoints virtual. Nota Ao criar um grupo de endpoints virtual para um listener da Camada 4, certifique-se de que um grupo de endpoints padrão foi criado. Valores válidos: default : Grupo de endpoints padrão. virtual : Grupo de endpoints virtual.	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 no mapeamento de porta. Nota Para listeners TCP: mapeamentos de porta não são suportados para grupos de endpoints virtuais. Se já existir um grupo de endpoints virtual sob o 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, aplicam-se os seguintes limites ao modificar o listener: você não pode alterar 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 o mapeamento de porta estiver configurado 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 deve ativar as verificações de integridade. Valores válidos: true: ativa as verificações de integridade. false: desativa as verificações de integridade.	true
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.	test-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.	test-value
DryRun	boolean	Não	Especifica se deve realizar um dry run. Valores válidos: true: realiza um dry run sem criar um grupo de endpoints. O sistema verifica se os parâmetros obrigatórios estão definidos, o formato da solicitação e os limites do serviço. Se a solicitação falhar no dry run, o sistema retorna um 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. Se a solicitação passar no dry run, o sistema retorna um código de status HTTP 2xx e cria um grupo de endpoints.	false
HealthCheckHost	string	Não	O nome de domínio usado para verificações de integridade.	www.taobao.com
EndpointIpVersion	string	Não	A versão IP do endereço IP 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 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 para a conexão do túnel de proxy.	prefix-auth
ConnectAuthSuffix	string	Não	O sufixo de autenticação para a conexão do túnel de proxy.	suffix-auth
ConnectSessionHashHdr	string	Não	O nome do cabeçalho de solicitação usado para hash de sessão.	X-Session-Hash
ConnectTunnelTimeout	integer	Não	O período de tempo limite para a conexão do túnel de proxy. Unidade: milissegundos.	5000
TunnelServerPort	integer	Não	A porta do servidor de túnel.	8443
TunnelServerType	string	Não	O tipo de endereço do servidor de túnel. Valores válidos: ip (endereço IPv4) e domain (nome de domínio).	domain
TunnelServer	string	Não	O endereço IPv4 ou nome de domínio do servidor de túnel.	tunnel.example.com
HealthCheckSuccessCodes	string	Não	O conjunto de códigos de status que indicam uma verificação de integridade bem-sucedida.	http_2xx,http_3xx
HealthCheckMethod	string	Não	O método de solicitação HTTP usado para verificações de integridade.	GET

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações retornadas.
EndpointGroupId	string	O ID do grupo de endpoints.	epg-bp1dmlohjjz4kqaun****
RequestId	string	O ID da solicitação.	04F0F334-1335-436C-A1D7-6C044FE73368

Exemplos

Resposta de sucesso

JSON formato

{
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

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	NotExist.ListenerPort	The listening port %s does not exist.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
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	Exist.EndpointGroup	The endpoint group already exists.
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.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.