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

Cria um grupo de endpoints.

Descrição da operação

Antes de criar um grupo de endpoints virtual para um listener da Camada 4, você deve primeiro criar um grupo de endpoints padrão.
CreateEndpointGroup é uma operação assíncrona. Depois que você envia uma solicitação, o sistema retorna um ID de grupo de endpoints e começa a criar o grupo de endpoints em segundo plano. Você pode chamar DescribeEndpointGroup para consultar o status do grupo de endpoints:
- Se o grupo de endpoints estiver no estado init, ele está sendo criado. Nesse estado, você pode realizar apenas operações de consulta.
- Se o grupo de endpoints estiver no estado active, ele foi criado.
Você não pode fazer chamadas simultâneas para a operação CreateEndpointGroup 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: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 onde a instância do Global Accelerator (GA) está implantada. 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 esse token, mas deve garantir que ele seja exclusivo para cada solicitação. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usa automaticamente o RequestId da solicitação como o ClientToken. Cada solicitação tem um RequestId exclusivo.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Sim	O ID da instância do GA.	ga-bp1odcab8tmno0hdq****
Name	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 dígitos, pontos (.), sublinhados (_) e hifens (-).	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 onde o grupo de endpoints está implantado.	cn-hangzhou
ListenerId	string	Sim	O ID do listener.	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	Não	A porcentagem de tráfego distribuído para o grupo de endpoints quando o listener está associado a vários grupos de endpoints. Valores válidos: 1 a 100.	20
HealthCheckIntervalSeconds	integer	Não	O intervalo de verificação de integridade, em segundos.	3
HealthCheckPath	string	Não	O caminho usado para verificações de integridade.	/healthcheck
HealthCheckPort	integer	Não	A porta usada para verificações de integridade.	20
HealthCheckProtocol	string	Não	O protocolo usado para verificações 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 de um endpoint mude entre íntegro e não íntegro. Valores válidos: 2 a 10. Valor padrão: 3.	3
EndpointConfigurations	array<object>	Não	As configurações do endpoint.
	object	Não	As configurações do endpoint.
Type	string	Sim	O tipo do endpoint. 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 do Elastic Compute Service (ECS). SLB: uma instância do Server Load Balancer (SLB). ALB: uma instância do Application Load Balancer (ALB). OSS: um bucket do Object Storage Service (OSS). ENI: uma interface de rede elástica (ENI). NLB: uma instância do Network Load Balancer (NLB). Nota Se você definir o tipo de endpoint como ECS, ENI, SLB, ALB, NLB ou IpTarget, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaVpcEndpoint, caso a função não exista. Se você definir o tipo de endpoint como ALB, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaAlb, caso a função não exista. Se você definir o tipo de endpoint como OSS, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaOss, caso a função não exista. Se você definir o tipo de endpoint como NLB, o sistema criará automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForGaNlb, caso a função não exista. Nota Para mais informações, consulte Funções vinculadas ao serviço.	Ip
EnableClientIPPreservation	boolean	Não	Especifica se os endereços IP de origem do cliente devem ser preservados. Valores válidos: true: preserva os endereços IP de origem do cliente. false (padrão): não preserva os endereços IP de origem do cliente. Nota Por padrão, esse recurso é desativado para grupos de endpoints associados a listeners TCP ou UDP. Você pode ativar esse recurso com base nos requisitos do seu negócio. Por padrão, esse recurso é ativado para grupos de endpoints associados a listeners HTTP ou HTTPS. O endereço IP de origem é recuperado do campo de cabeçalho X-Forwarded-For. Esse recurso não pode ser desativado. EnableClientIPPreservation e EnableProxyProtocol não podem ser definidos como true ao mesmo tempo. Para mais informações, consulte Preservar endereços IP de origem do cliente.	false
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 para de distribuir tráfego para ele. Prossiga com cautela.	20
EnableProxyProtocol	boolean	Não	Especifica se o protocolo PROXY deve ser usado para preservar os endereços IP de origem do cliente. Valores válidos: true: usa o protocolo PROXY. false (padrão): não usa o protocolo PROXY. Nota Este parâmetro pode ser configurado 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 de origem do cliente.	false
Endpoint	string	Sim	O endereço IP, o nome de domínio ou o ID do recurso do endpoint. O valor deste parâmetro depende do valor do parâmetro Type.	120.1.XX.XX
SubAddress	string	Não	O endereço IP privado da ENI. Nota Este parâmetro se aplica apenas quando o tipo de endpoint é definido como ENI. Se você omitir este parâmetro, o endereço IP privado principal da ENI será usado.	172.168.X.X
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 de um listener de roteamento inteligente. Nota Este parâmetro é obrigatório apenas quando o tipo de endpoint é definido como IpTarget.	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	Não	Uma lista de 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 quando o tipo de endpoint é IpTarget. O vSwitch deve pertencer à VPC especificada pelo parâmetro VpcId.	vsw-bp12mho4ze51ezagm****
Provider	string	Não	The AI service provider. Set this to `BAILIAN` to use Alibaba Cloud Model Studio.	BAILIAN
ApiKeys	array	Não	The API keys for the AI service.
	string	Não	The API key for the AI service.	sk-***********
EndpointRequestProtocol	string	Não	O protocolo usado pelo serviço de backend. Valores válidos: HTTP (padrão) HTTPS Nota Este parâmetro está disponível apenas para grupos de endpoints de listeners 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. Valores válidos: HTTP1.1 (padrão): HTTP/1.1. HTTP2: HTTP/2. Nota Este parâmetro está disponível apenas quando EndpointRequestProtocol é definido como HTTPS.	HTTP1.1
EndpointGroupType	string	Não	O tipo do grupo de endpoints. Valores válidos: default (padrão): um grupo de endpoints padrão. virtual: um grupo de endpoints virtual. Nota Antes de criar um grupo de endpoints virtual para um listener da Camada 4, certifique-se de ter criado um grupo de endpoints padrão.	default
PortOverrides	array<object>	Não	Os mapeamentos de porta de listener para endpoint.
	object	Não	Os mapeamentos de porta de listener para endpoint.
ListenerPort	integer	Não	A porta do listener para o mapeamento de porta. Nota Para listeners TCP, você não pode configurar mapeamentos de porta para grupos de endpoints virtuais. Se um listener estiver associado a um grupo de endpoints virtual, você não poderá configurar mapeamentos de porta para o grupo de endpoints padrão. Se um grupo de endpoints padrão tiver mapeamentos de porta configurados, você não poderá adicionar um grupo de endpoints virtual. Depois de configurar os mapeamentos 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 nos mapeamentos de porta. Por exemplo, se o intervalo de portas do listener for 80-82 e as portas do listener forem 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 para o mapeamento de porta.	80
HealthCheckEnabled	boolean	Não	Especifica se as verificações de integridade devem ser ativadas. 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. 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. 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 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, 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. Se a solicitação passar na verificação, o sistema retorna um código de status HTTP 2xx e cria o 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 do IP usada para se comunicar com o serviço de backend. Valores válidos: IPv4 (padrão): o GA usa apenas IPv4 para se comunicar com o serviço de backend. IPv6: o GA usa apenas IPv6 para se comunicar com o serviço de backend. ProtocolAffinity: o GA usa a mesma versão de IP da solicitação do cliente para se comunicar com o serviço de backend.	IPv4

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
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	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	NotExist.ListenerPort	The listening port %s does not exist.	The listening port does not exist.
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.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	Exist.EndpointGroup	The endpoint group already exists.	The endpoint group already exists.
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.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.