All Products
Search
Document Center

Global Accelerator:ListCustomRoutingEndpointGroups

Last Updated:Apr 28, 2024

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.

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:ListCustomRoutingEndpointGroupsList
  • CustomRoutingEndpointGroup
    acs:ga:*:{#accountId}:ga/{#gaId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. 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 custom routing listener.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstringNo

The ID of the endpoint group.

epg-bp14sz7ftcwwjgrdm****
AccessLogSwitchstringNo

Specifies whether the access log feature is enabled.

You can set the parameter to on.

If you leave the parameter empty, all endpoint groups are returned.

on

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The number of entries returned.

1
PageSizeinteger

The number of entries returned on each page.

10
PageNumberinteger

The page number of the returned page.

1
EndpointGroupsobject []

The configuration information about the endpoint group.

AcceleratorIdstring

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
ListenerIdstring

The ID of the custom routing listener.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring

The ID of the endpoint group.

epg-bp14sz7ftcwwjgrdm****
Namestring

The name of the endpoint group.

group1
Descriptionstring

The description of the endpoint group.

EndpointGroup
EndpointGroupIpListarray

The endpoint group IP addresses.

string

The endpoint group IP address.

203.0.XX.XX
EndpointGroupUnconfirmedIpListarray

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
EndpointGroupRegionstring

The ID of the region where the endpoint group is created.

cn-hangzhou
Statestring

The status of the endpoint group. Valid values:

  • init
  • active
  • updating
  • deleting
active
ServiceIdstring

The ID of the service that manages the 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
ServiceManagedInfosobject []

The 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.

Actionstring

The name of the action on the managed instance. Valid values:

  • Create
  • Update
  • Delete
  • Associate
  • UserUnmanaged
  • CreateChild
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.

  • true: Users cannot perform the specified actions on the managed instance.
  • false: Users 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,
  "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": false
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-25The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AccessLogSwitch
2023-08-15The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-07-20The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-04-20The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.