Gunakan ListEndpointGroups - Global Accelerator - Alibaba Cloud - Global Accelerator

Mencantumkan kelompok titik akhir.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ga:ListEndpointGroups

list

*EndpointGroup

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID Wilayah tempat instans Akselerator Global di-deploy. Tetapkan nilai ke cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 50. Nilai default: 10.	10
AcceleratorId	string	Yes	ID instans Akselerator Global.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	ID Pendengar daftar.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	No	Tipe kelompok titik akhir. Nilai valid: default: kelompok titik akhir default. virtual: kelompok titik akhir virtual. Jika Anda menghilangkan parameter ini, operasi akan mengembalikan semua kelompok titik akhir default dan virtual.	virtual
AccessLogSwitch	string	No	Apakah akan mengaktifkan Log akses. Nilai valid: on: mengaktifkan Log akses. off (default): menonaktifkan Log akses.	on
EndpointGroupId	string	No	ID kelompok titik akhir.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	No	Tag yang digunakan untuk memfilter kelompok titik akhir. Anda dapat menentukan hingga 20 tag.
	object	No	A tag.
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 64 characters long and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	test-key
Value	string	No	The tag value. The tag value can be an empty string. The tag value can be up to 128 characters long and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	test-value

Elemen respons

Element	Type	Description	Example
	object	The response data.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	The page number.	1
EndpointGroups	array<object>	The list of endpoint groups.
	array<object>	The list of endpoint groups.
EndpointGroupId	string	The ID of the endpoint group.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	A list of public egress IP addresses of the endpoint group. Penting For endpoint groups connected to private backend services, the console shows only the private source IP addresses, not the public ones. If the network connection type of a backend service changes (for example, from private to public), monitor the source IP addresses and update the backend service's access control list (ACL).
	string	A public egress IP address of the endpoint group.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	The list of new IP addresses in the endpoint group that require confirmation after a Global Accelerator instance is upgraded.
	string	A new IP address in the endpoint group that requires confirmation after a Global Accelerator instance is upgraded.	47.1.XX.XX
State	string	The state of the endpoint group. init: The endpoint group is initializing. active: The endpoint group is stable. updating: The endpoint group is updating. deleting: The endpoint group is deleting.	active
HealthCheckPath	string	The health check path.	/healthcheck
EndpointGroupRegion	string	The ID of the region where the endpoint group is deployed.	cn-hangzhou
HealthCheckIntervalSeconds	integer	The health check interval, in seconds.	3
TrafficPercentage	integer	The percentage of traffic routed to the endpoint group. This parameter applies only if a listener is associated with multiple endpoint groups.	100
HealthCheckProtocol	string	The protocol used for health checks. tcp or TCP: TCP http or HTTP: HTTP https or HTTPS: HTTPS	tcp
ThresholdCount	integer	The number of consecutive failed health checks required to mark an endpoint as unhealthy.	3
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	The ID of the Global Accelerator instance.	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	A list of endpoint configurations.
	object	An endpoint configuration.
Type	string	The type of endpoint. Valid values: Domain: A custom domain name. Ip: A custom IP address. IpTarget: A private IP address. PublicIp: An Alibaba Cloud public IP address. ECS: An Alibaba Cloud ECS instance. SLB: An Alibaba Cloud SLB instance. ALB: An Alibaba Cloud ALB instance. OSS: An Alibaba Cloud OSS bucket. ENI: An Alibaba Cloud elastic network interface. NLB: An Alibaba Cloud NLB instance.	Ip
EnableClientIPPreservation	boolean	Indicates whether client IP preservation is enabled. Valid values: true: Client IP preservation is enabled. false: Client IP preservation is disabled.	false
Weight	integer	The weight of the endpoint.	20
ProbeProtocol	string	The protocol used for latency monitoring probes. Valid values: icmp: ICMP tcp: TCP	tcp
Endpoint	string	The IP address, domain name, or instance ID of the endpoint.	47.1.XX.XX
EnableProxyProtocol	boolean	Indicates whether the proxy protocol is used to preserve client IP addresses. Valid values: true: The proxy protocol is enabled. false: The proxy protocol is disabled.
ProbePort	integer	The port used for latency monitoring probes.	80
EndpointId	string	The ID of the endpoint.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	The private IP address of the elastic network interface.	172.168.XX.XX
VpcId	string	The ID of the VPC.	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	A list of vSwitches in the VPC.
	string	The ID of the vSwitch.	vsw-hp3xwc2aebg2u30ln****
Provider	string		BAILIAN
ApiKeys	array
	string		sk-*******
PortOverrides	array<object>	The port mappings.
	object	The port mappings.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
ForwardingRuleIds	array	The IDs of forwarding rules associated with the endpoint group.
	string	The ID of a forwarding rule associated with the endpoint group.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	The type of the endpoint group. Valid values: default: a default endpoint group. virtual: a virtual endpoint group.	default
EndpointRequestProtocol	string	The protocol of the backend service. Valid values: HTTP: HTTP HTTPS: HTTPS	HTTP
EndpointProtocolVersion	string	The version of the backend service protocol. Valid values: HTTP1.1: HTTP/1.1 HTTP2: HTTP/2	HTTP1.1
Description	string	The description of the endpoint group.	group1
Name	string	The name of the endpoint group.	group1
HealthCheckPort	integer	The port used for health checks.	10
HealthCheckEnabled	boolean	Specifies whether to enable health checks. true: Health checks are enabled. false: Health checks are disabled.	true
ServiceId	string	The ID of the service that manages the instance. Catatan This parameter is returned only if ServiceManaged is true.	ALB
ServiceManaged	boolean	Specifies whether the instance is managed. Valid values: true: The instance is a managed instance. false: The instance is not a managed instance.	true
ServiceManagedInfos	array<object>	The actions that you can perform on the managed instance. Catatan This parameter is returned only if ServiceManaged is true. Your permissions to operate on a managed instance are restricted.
	object	The actions that you can perform on the managed instance.
Action	string	The name of the action on the managed instance. Valid values: Create: Create an instance. Update: Update the instance. Delete: Delete the instance. Associate: Associate the instance with other resources. UserUnmanaged: Unmanage the instance. CreateChild: Create a child resource for the instance.	Update
ChildType	string	The type of the child resource. Valid values: Listener: a listener. IpSet: an acceleration region. EndpointGroup: an endpoint group. ForwardingRule: a forwarding rule. Endpoint: an endpoint. EndpointGroupDestination: a protocol mapping for an endpoint group of a custom routing listener. EndpointPolicy: a traffic policy for an endpoint of a custom routing listener. Catatan This parameter is returned only if Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the action is managed. Valid values: true: The action is managed. You cannot perform the specified action on the managed instance. false: The action is not managed. You can perform the specified action on the managed instance.	false
Tags	array<object>	The tags attached to the endpoint group.
	object	A tag of the endpoint group.
Key	string	The tag key.	test-key
Value	string	The tag value.	test-value
HealthCheckHost	string	The domain name used for health checks.	www.taobao.com
EndpointIpVersion	string	The IP protocol of the backend service. Valid values: IPv4 (default): Connections to the backend service use IPv4. IPv6: Connections to the backend service use IPv6. ProtocolAffinity: The connection to the backend service uses the same IP protocol as the client request.	IPv4
EndpointPrivateIpList	array<object>	A list of private IP addresses of the endpoints.
	object
PrivateIp	string	The private IP address.	172.19.115.37
VSwitchId	string	The ID of the vSwitch in the VPC.	gsw-0jl6tmriqep1ga***
CIDR	string

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194\t",
  "PageNumber": 1,
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointGroupIpList": [
        "47.1.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "47.1.XX.XX"
      ],
      "State": "active",
      "HealthCheckPath": "/healthcheck",
      "EndpointGroupRegion": "cn-hangzhou",
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 100,
      "HealthCheckProtocol": "tcp",
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "47.1.XX.XX",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX",
          "VpcId": "vpc-8vbhucmd5b2q2fpqqu****",
          "VSwitchIds": [
            "vsw-hp3xwc2aebg2u30ln****"
          ],
          "Provider": "BAILIAN",
          "ApiKeys": [
            "sk-*******"
          ]
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "HTTP1.1",
      "Description": "group1",
      "Name": "group1",
      "HealthCheckPort": 10,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": ""
        }
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.