CreateEndpointGroup - - Alibaba Cloud Dokümantasyon Merkezi

Bir uç nokta grubu oluşturur.

Operation description

1. Katman dinleyicisi için sanal bir uç nokta grubu oluşturmak üzere bu işlemi çağırdığınızda, varsayılan bir uç nokta grubunun oluşturulduğundan emin olun.
CreateEndpointGroup eşzamansız bir işlemdir. Bu işlemi çağırdıktan sonra sistem bir uç nokta grubu kimliği döndürür, ancak uç nokta grubu henüz oluşturulmamıştır ve oluşturma görevi arka planda çalışmaya devam etmektedir. Uç nokta grubunun durumunu sorgulamak için DescribeEndpointGroup işlemini çağırabilirsiniz:
- Uç nokta grubu init durumundayken, uç nokta grubu oluşturulmaktadır. Bu durumda yalnızca sorgulama işlemleri gerçekleştirebilirsiniz.
- Uç nokta grubu active durumundayken, uç nokta grubu oluşturulmuştur.
Aynı Global Accelerator (GA) örneği için eşzamanlı olarak uç nokta grupları oluşturmak üzere CreateEndpointGroup işlemini çağıramazsınız.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Global Accelerator (GA) örneğinin bölge kimliği. Değeri cn-hangzhou olarak ayarlayın.	cn-hangzhou
ClientToken	string	No	İsteğin idempotent olmasını sağlamak için kullanılan istemci belirteci. Değeri oluşturmak için istemciyi kullanabilirsiniz, ancak değerin farklı istekler arasında benzersiz olduğundan emin olmalısınız. İstemci belirteci yalnızca ASCII karakterleri içerebilir. Not Bu parametreyi ayarlamazsanız, sistem otomatik olarak API isteğinin RequestId değerini ClientToken olarak kullanır. Her API isteğinin RequestId değeri benzersizdir.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	Global Accelerator (GA) örneğinin kimliği.	ga-bp1odcab8tmno0hdq****
Name	string	No	Uç nokta grubunun adı. Ad 1 ila 128 karakter uzunluğunda olmalı ve rakam, nokta (.), alt çizgi (_) ve tire (-) içerebilir. Bir harf veya Çince karakterle başlamalıdır.	group1
Description	string	No	Uç nokta grubunun açıklaması. Açıklama en fazla 200 karakter uzunluğunda olabilir ve `http://` veya `https://` ile başlayamaz.	EndpointGroup
EndpointGroupRegion	string	Yes	Uç nokta grubunun bölge kimliği.	cn-hangzhou
ListenerId	string	Yes	Dinleyicinin kimliği.	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	No	Dinleyicinin birden fazla uç nokta grubuna sahip olması durumunda uç nokta grubuna dağıtılan trafik yüzdesi. Geçerli değerler: 1 ila 100.	20
HealthCheckIntervalSeconds	integer	No	Ardışık iki sağlık kontrolü arasındaki aralık. Birim: saniye.	3
HealthCheckPath	string	No	Sağlık kontrolü yolu.	/healthcheck
HealthCheckPort	integer	No	Sağlık kontrolü bağlantı noktası.	20
HealthCheckProtocol	string	No	Sağlık kontrolü protokolü. Geçerli değerler: tcp veya TCP: TCP. http veya HTTP: HTTP. https veya HTTPS: HTTPS.	tcp
ThresholdCount	integer	No	Sağlık kontrolü durumunun başarıdan başarısızlığa veya başarısızlıktan başarıya değişmesinden önce başarılı veya başarısız olması gereken ardışık sağlık kontrolü sayısı. Geçerli değerler: 2 ila 10. Varsayılan değer: 3.	3
EndpointConfigurations	array<object>	No	Uç nokta yapılandırmaları.
	object	No	Uç nokta yapılandırmaları.
Type	string	Yes	Uç nokta türü. Geçerli değerler: Domain: özel etki alanı adı. Ip: özel IP adresi. IpTarget: özel dahili IP adresi. PublicIp: Alibaba Cloud genel IP adresi. ECS: ECS örneği. SLB: Classic Load Balancer (CLB) örneği. ALB: Application Load Balancer (ALB) örneği. OSS: Object Storage Service (OSS) örneği. ENI: Alibaba Cloud esnek ağ arabirimi denetleyicisi (NIC). NLB: Network Load Balancer (NLB) örneği. Not Uç nokta türü ECS, ENI, SLB, ALB, NLB veya IpTarget olarak ayarlanmışsa ve hizmete bağlı rol mevcut değilse, sistem otomatik olarak AliyunServiceRoleForGaVpcEndpoint adında bir hizmete bağlı rol oluşturur. Uç nokta türü ALB olarak ayarlanmışsa ve hizmete bağlı rol mevcut değilse, sistem otomatik olarak AliyunServiceRoleForGaAlb adında bir hizmete bağlı rol oluşturur. Uç nokta türü OSS olarak ayarlanmışsa ve hizmete bağlı rol mevcut değilse, sistem otomatik olarak AliyunServiceRoleForGaOss adında bir hizmete bağlı rol oluşturur. Uç nokta türü NLB olarak ayarlanmışsa ve hizmete bağlı rol mevcut değilse, sistem otomatik olarak AliyunServiceRoleForGaNlb adında bir hizmete bağlı rol oluşturur. Not Daha fazla bilgi için bkz. Hizmete bağlı roller.	Ip
EnableClientIPPreservation	boolean	No	Otomatik alma yöntemini kullanarak istemci IP adresi korumasının etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler: true: İstemci IP adresi korumasını etkinleştirir. false (varsayılan): İstemci IP adresi korumasını devre dışı bırakır. Not Varsayılan olarak, UDP veya TCP dinleyicilerine karşılık gelen uç nokta grupları için istemci IP adresi koruması devre dışıdır. Bu özelliği iş gereksinimlerinize göre yapılandırabilirsiniz. Varsayılan olarak, HTTP veya HTTPS dinleyicilerine karşılık gelen uç nokta grupları için istemci IP adresi koruması etkinleştirilmiştir. İstemci IP adresları X-Forwarded-For üst bilgi alanı kullanılarak alınır. Bu özelliği devre dışı bırakamazsınız. Hem EnableClientIPPreservation hem de EnableProxyProtocol parametrelerini true olarak ayarlayamazsınız. Daha fazla bilgi için bkz. İstemci IP adreslarını koruma.	false
Weight	integer	Yes	Uç noktanın ağırlığı. Geçerli değerler: 0 ila 255. Not Bir uç noktanın ağırlığı 0 olarak ayarlanırsa, Global Accelerator uç noktaya trafik dağıtmayı durdurur. Dikkatli ilerleyin.	20
EnableProxyProtocol	boolean	No	Proxy Protokolünü kullanarak istemci IP adresi korumasının etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler: true: İstemci IP adresi korumasını etkinleştirir. false (varsayılan): İstemci IP adresi korumasını devre dışı bırakır. Not Bu parametre yalnızca TCP dinleyicilerine karşılık gelen uç nokta grupları için desteklenir. Hem EnableClientIPPreservation hem de EnableProxyProtocol parametrelerini true olarak ayarlayamazsınız. Daha fazla bilgi için bkz. İstemci IP adreslarını koruma.	false
Endpoint	string	Yes	Uç noktanın IP adresi, etki alanı adı veya örnek kimliği. Değeri uç nokta türüne göre belirtin.	120.1.XX.XX
SubAddress	string	No	Esnek ağ arabirimi denetleyicisinin (NIC) özel IP adresi. Not Uç nokta türü ENI olduğunda bu parametre isteğe bağlıdır. Bu parametreyi ayarlamazsanız, varsayılan olarak esnek ağ arabirimi denetleyicisinin (NIC) birincil özel IP adresi kullanılır.	172.168.X.X
VpcId	string	No	Sanal özel bulutun (VPC) kimliği. Akıllı yönlendirme dinleyicisinin bir uç nokta grubu için en fazla bir VPC kimliği belirtebilirsiniz. Not Bu parametre yalnızca uç nokta türü IpTarget olduğunda gereklidir ve geçerli olur.	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	No	VPC'deki vSwitch'ler.
	string	No	vSwitch'in kimliği. Akıllı yönlendirme dinleyicisinin bir uç nokta grubu için en fazla iki vSwitch kimliği belirtebilirsiniz. Not Bu parametre yalnızca uç nokta türü IpTarget olduğunda gereklidir ve geçerli olur. vSwitch, VpcId parametresiyle belirtilen VPC'ye ait olmalıdır.	vsw-bp12mho4ze51ezagm****
Provider	string	No	Uç nokta yapılandırmasındaki hizmet sağlayıcı.	BAILIAN
ApiKeys	array	No	Uç nokta yapılandırmasındaki API anahtarları.
	string	No	Uç nokta yapılandırmasındaki ilk API anahtarı.	sk-***********
EndpointRequestProtocol	string	No	Arka uç hizmet protokolü. Geçerli değerler: HTTP (varsayılan) HTTPS Not Bu parametre yalnızca bir HTTP veya HTTPS dinleyicisi için uç nokta grubu oluşturduğunuzda desteklenir. Bir HTTP dinleyicisi için arka uç hizmet protokolü yalnızca HTTP olabilir.	HTTP
EndpointProtocolVersion	string	No	Arka uç hizmet protokolünün sürümü. Geçerli değerler: HTTP1.1 (varsayılan): HTTP/1.1. HTTP2: HTTP/2. Not Arka uç hizmet protokolü sürümünü yalnızca EndpointRequestProtocol parametresi HTTPS olarak ayarlandığında belirtebilirsiniz.	HTTP1.1
EndpointGroupType	string	No	Uç nokta grubu türü. Geçerli değerler: default (varsayılan): varsayılan uç nokta grubu. virtual: sanal uç nokta grubu. Not Katman dinleyicisi için sanal bir uç nokta grubu oluştururken, varsayılan bir uç nokta grubunun oluşturulduğundan emin olun. Valid values: default : Varsayılan uç nokta grubu. virtual : Sanal uç nokta grubu.	default
PortOverrides	array<object>	No	Bağlantı noktası eşlemeleri.
	object	No	Bağlantı noktası eşlemeleri.
ListenerPort	integer	No	Bağlantı noktası eşlemesindeki dinleyici bağlantı noktası. Not TCP dinleyicileri için: Sanal uç nokta grupları için bağlantı noktası eşlemeleri desteklenmez. Dinleyici altında zaten bir sanal uç nokta grubu varsa, varsayılan uç nokta grubu için bağlantı noktası eşlemeleri yapılandıramazsınız. Varsayılan uç nokta grubu için zaten bağlantı noktası eşlemeleri yapılandırılmışsa, sanal bir uç nokta grubu ekleyemezsiniz. Bağlantı noktası eşlemelerini yapılandırdıktan sonra, dinleyiciyi değiştirirken aşağıdaki sınırlamalar geçerli olur: HTTP ve HTTPS arasında geçiş yapmak dışında dinleyici protokolünü değiştiremezsiniz. Dinleyici bağlantı noktası: Değiştirilen dinleyici bağlantı noktası aralığı, mevcut bağlantı noktası eşlemelerindeki tüm dinleyici bağlantı noktalarını içermelidir. Örneğin, dinleyici bağlantı noktası aralığı 80 ila 82 ise ve bağlantı noktası eşlemesi 100 ila 102 uç nokta bağlantı noktalarına yapılandırılmışsa, dinleyici bağlantı noktası aralığını 80 ila 81 olarak değiştiremezsiniz.	443
EndpointPort	integer	No	Bağlantı noktası eşlemesindeki uç nokta bağlantı noktası.	80
HealthCheckEnabled	boolean	No	Sağlık kontrollerinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler: true: Sağlık kontrollerini etkinleştirir. false: Sağlık kontrollerini devre dışı bırakır.	true
Tag	array<object>	No	Uç nokta grubunun etiketleri.
	object	No	Uç nokta grubunun etiketleri.
Key	string	No	Uç nokta grubunun etiket anahtarı. Etiket anahtarı boş bir dize olamaz. Etiket anahtarı en fazla 64 karakter uzunluğunda olabilir ve `aliyun` veya `acs:` ile başlayamaz. `http://` veya `https://` içeremez. En fazla 20 etiket anahtarı belirtebilirsiniz.	test-key
Value	string	No	Uç nokta grubunun etiket değeri. Etiket değeri boş bir dize olabilir. Etiket değeri en fazla 128 karakter uzunluğunda olabilir ve `aliyun` veya `acs:` ile başlayamaz. `http://` veya `https://` içeremez. En fazla 20 etiket değeri belirtebilirsiniz.	test-value
DryRun	boolean	No	Deneme çalıştırması yapılıp yapılmayacağını belirtir. Geçerli değerler: true: Uç nokta grubu oluşturmadan deneme çalıştırması yapar. Sistem gerekli parametrelerin ayarlanıp ayarlanmadığını, istek biçimini ve hizmet sınırlarını kontrol eder. İstek deneme çalıştırmasından geçemezse, sistem bir hata döndürür. İstek deneme çalıştırmasından geçerse, sistem bir HTTP 2xx durum kodu döndürür. false (varsayılan): Normal bir istek gönderir. İstek deneme çalıştırmasından geçerse, sistem bir HTTP 2xx durum kodu döndürür ve bir uç nokta grubu oluşturur.	false
HealthCheckHost	string	No	Sağlık kontrolleri için kullanılan etki alanı adı.	www.taobao.com
EndpointIpVersion	string	No	Arka uç IP adresının IP sürümü. Geçerli değerler: IPv4 (varsayılan): GA, uç nokta hizmetiyle yalnızca IPv4 üzerinden iletişim kurar. IPv6: GA, uç nokta hizmetiyle yalnızca IPv6 üzerinden iletişim kurar. ProtocolAffinity: GA, uç nokta hizmetiyle istemci isteğiyle aynı IP sürümü üzerinden iletişim kurar.	IPv4
ProxyTunnel	object	No	Proxy tüneli yapılandırması.
ConnectAuthPrefix	string	No	Proxy tüneli bağlantısı için kimlik doğrulama öneki.	prefix-auth
ConnectAuthSuffix	string	No	Proxy tüneli bağlantısı için kimlik doğrulama soneki.	suffix-auth
ConnectSessionHashHdr	string	No	Oturum karması için kullanılan istek üst bilgisinin adı.	X-Session-Hash
ConnectTunnelTimeout	integer	No	Proxy tüneli bağlantısı için zaman aşımı süresi. Birim: milisaniye.	5000
TunnelServerPort	integer	No	Tünel sunucusu bağlantı noktası.	8443
TunnelServerType	string	No	Tünel sunucusunun adres türü. Geçerli değerler: ip (IPv4 adresi) ve domain (etki alanı adı).	domain
TunnelServer	string	No	Tünel sunucusunun IPv4 adresi veya etki alanı adı.	tunnel.example.com
HealthCheckSuccessCodes	string	No	Başarılı bir sağlık kontrolünü belirten durum kodları kümesi.	http_2xx,http_3xx
HealthCheckMethod	string	No	Sağlık kontrolleri için kullanılan HTTP istek yöntemi.	GET

Response elements

Element	Type	Description	Example
	object	Döndürülen bilgiler.
EndpointGroupId	string	Uç nokta grubunun kimliği.	epg-bp1dmlohjjz4kqaun****
RequestId	string	İstek kimliği.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.