Query endpoint group mapping configurations of a custom routing listener - Global Accelerator - Alibaba Cloud - Global Accelerator

Invokes the ListCustomRoutingEndpointGroupDestinations operation to query the destination configurations of an endpoint group for a custom route listener.

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

list

*CustomRoutingEndpointGroupDestination

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	10
AcceleratorId	string	Yes	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance for which you want to query endpoint group destination configurations.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	The ID of the listener for which you want to query endpoint group destination configurations.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	No	The ID of the endpoint group for which you want to query destination configurations.	epg-bp16jdc00bhe97sr5****
Protocols	array	No	The protocol type of the backend service of the endpoint group. Valid values: TCP: TCP protocol. UDP: UDP protocol. TCP,UDP: TCP and UDP protocols. If this parameter is left empty, all protocol types are queried. You can specify up to 10 protocol entries.
	string	No	The protocol type of the backend service of the endpoint group. Valid values: TCP: TCP protocol. UDP: UDP protocol. TCP,UDP: TCP and UDP protocols. If this parameter is left empty, all protocol types are queried. You can specify up to 10 protocol entries.	TCP
FromPort	integer	No	The start port of the backend service of the endpoint group. Valid values: 1 to 65499. The value of FromPort must be less than or equal to the value of ToPort.	80
ToPort	integer	No	The end port of the backend service of the endpoint group. Valid values: 1 to 65499. The value of FromPort must be less than or equal to the value of ToPort.	80

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries per page in a paging query.	10
PageNumber	integer	The page number of the list.	1
Destinations	array<object>	The destination configurations of the endpoint group.
	array<object>	The destination configurations of the endpoint group.
AcceleratorId	string	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance to which the endpoint group destination configuration belongs.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the listener to which the endpoint group destination configuration belongs.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The ID of the endpoint group to which the destination configuration belongs.	epg-bp14sz7ftcwwjgrdm****
DestinationId	string	The ID of the endpoint group destination configuration.	dst-123abc****
Protocols	array	The Protocol Type of the backend service of the endpoint group. TCP: TCP protocol. UDP: UDP protocol. TCP,UDP: TCP and UDP protocols.
	string	The Protocol Type of the backend service of the endpoint group. TCP: TCP protocol. UDP: UDP protocol. TCP,UDP: TCP and UDP protocols.	TCP
FromPort	integer	The start port of the backend service of the endpoint group.	80
ToPort	integer	The end port of the backend service of the endpoint group.	80
ServiceId	string	The ID of the service to which the managed instance belongs. Note This parameter is valid only when ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates whether the instance is managed. Valid values: true: The instance is managed. false: The instance is not managed.	true
ServiceManagedInfos	array<object>	The list of action policies that the user can execute on the managed instance. Note This parameter is valid only when ServiceManaged is set to True. When the instance is in the managed state, user operations on the instance are restricted, and certain operations are prohibited.
	object	The list of action policies that the user can execute on the managed instance.
Action	string	The name of the action that you can perform on the managed instance. Valid values: Create: Create an instance. Update: Update the current instance. Delete: Delete the current instance. Associate: Reference the current instance. UserUnmanaged: Unmanage the instance. CreateChild: Create a child resource in the current instance.	Create
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	Indicates whether the specified actions are managed. Valid values: true: The specified actions are managed, and you cannot perform the specified actions on the managed instance. false: The specified actions are not managed, and you 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,
  "Destinations": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "DestinationId": "dst-123abc****",
      "Protocols": [
        "TCP"
      ],
      "FromPort": 80,
      "ToPort": 80,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Create",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

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.