Use ListCustomRoutingEndpointGroups to query endpoint groups of a custom routing listener - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the endpoint groups that are associated with a custom routing listener.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

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:ListCustomRoutingEndpointGroups

list

*CustomRoutingEndpointGroup

acs:ga:*:{#accountId}:ga/{#gaId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	The ID of the custom routing listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	No	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****
AccessLogSwitch	string	No	Whether access logging is enabled. Valid value: on. If left empty, all endpoint groups are returned.	on

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The number of entries returned.	1
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
EndpointGroups	array<object>	The endpoint group configurations.
	array<object>	The endpoint group configurations.
AcceleratorId	string	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the custom routing listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****
Name	string	The name of the endpoint group.	group1
Description	string	The description of the endpoint group.	EndpointGroup
EndpointGroupIpList	array	The endpoint group IP addresses.
	string	The endpoint group IP address.	203.0.XX.XX
EndpointGroupUnconfirmedIpList	array	The endpoint group IP addresses to be confirmed after the GA instance is upgraded.
	string	The endpoint group IP address to be confirmed after the GA instance is upgraded.	203.0.XX.XX
EndpointGroupRegion	string	The ID of the region where the endpoint group is created.	cn-hangzhou
State	string	The status of the endpoint group. Valid values: init active updating deleting	active
ServiceId	string	The ID of the service that manages the instance. Note This parameter takes effect only if ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Whether the GA instance is managed. Valid values: true false	true
ServiceManagedInfos	array<object>	Actions that users can perform on the managed instance. Note This parameter takes effect only if ServiceManaged is set to True. Users can perform only specific actions on a managed instance.
	object	Action policies for the managed instance.
Action	string	The name of the action on the managed instance. Valid values: Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	The type of the child resource. Valid values: Listener: listener IpSet: acceleration region EndpointGroup: endpoint group ForwardingRule: forwarding rule Endpoint: endpoint EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener Note This parameter takes effect only if Action is set to CreateChild.	Listener
IsManaged	boolean	Whether the specified actions are managed. true: Users cannot perform the specified actions on the managed instance. false: Users can perform the specified actions on the managed instance.	false

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "EndpointGroups": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "Name": "group1",
      "Description": "EndpointGroup",
      "EndpointGroupIpList": [
        "203.0.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "203.0.XX.XX"
      ],
      "EndpointGroupRegion": "cn-hangzhou",
      "State": "active",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": true
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.	No permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.