All Products
Search
Document Center

Global Accelerator:ListCustomRoutingEndpointGroupDestinations

Last Updated:Jul 31, 2024

Queries endpoint group mapping configurations of a custom routing listener of a Global Accelerator (GA) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ListCustomRoutingEndpointGroupDestinationslist
  • CustomRoutingEndpointGroupDestination
    acs:ga:{#regionId}:{#accountId}:ga/{#gaId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the GA instance. Set the value to cn-hangzhou.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
AcceleratorIdstringYes

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
ListenerIdstringNo

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstringNo

The ID of the endpoint group.

epg-bp16jdc00bhe97sr5****
ProtocolsarrayNo

The backend service protocols of the endpoint group. Valid values:

  • TCP: TCP.
  • UDP: UDP.
  • TCP,UDP: TCP and UDP.

If this parameter is empty, all types of protocols are queried.

You can specify up to 10 protocols.

stringNo

The backend service protocol of the endpoint group. Valid values:

  • TCP: TCP
  • UDP: UDP
  • TCP,UDP: TCP and UDP

If this parameter is left empty, all protocols are queried.

You can specify up to 10 protocols.

TCP
FromPortintegerNo

The start port of the backend service port range of the endpoint group.

Valid values: 1 to 65499. The FromPort value must be smaller than or equal to the ToPort value.

80
ToPortintegerNo

The end port of the backend service port range of the endpoint group.

Valid values: 1 to 65499. The FromPort value must be smaller than or equal to the ToPort value.

80

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The number of the returned page.

1
Destinationsarray<object>

The details about the endpoint group mappings.

object

The details about the endpoint group mappings.

AcceleratorIdstring

The GA instance ID.

ga-bp1odcab8tmno0hdq****
ListenerIdstring

The listener ID.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring

The endpoint group ID.

epg-bp14sz7ftcwwjgrdm****
DestinationIdstring

The ID of the endpoint group mapping.

dst-123abc****
Protocolsarray

The backend service protocols of the endpoint group. Valid values:

  • TCP
  • UDP
  • TCP,UDP
string

The backend service protocol of the endpoint group. Valid values:

  • TCP
  • UDP
  • TCP,UDP
TCP
FromPortinteger

The first port of the backend service port range.

80
ToPortinteger

The last port of the backend service port range.

80
ServiceIdstring

The ID of the service that manages the GA instance.

Note This parameter takes effect only if ServiceManaged is set to True.
ALB
ServiceManagedboolean

Indicates whether the GA instance is managed. Valid values:

  • true
  • false
true
ServiceManagedInfosarray<object>

The actions that you can perform on the managed instance.

Note
  • This parameter takes effect only if ServiceManaged is set to True.
  • You can perform only specific actions on the managed instance.
  • object

    Details about the action that you can perform on the managed instance.

    Actionstring

    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.
    Update
    ChildTypestring

    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
    IsManagedboolean

    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

    Sample success responses

    JSONformat

    {
      "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": "Update",
              "ChildType": "Listener",
              "IsManaged": false
            }
          ]
        }
      ]
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermissionNo permissions.No permissions.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-07-23The Error code has changedView Change Details
    2023-07-20The internal configuration of the API is changed, but the call is not affectedView Change Details