Query a custom routing endpoint group by using DescribeCustomRoutingEndpointGroup - Global Accelerator - Alibaba Cloud - Global Accelerator

Invokes the DescribeCustomRoutingEndpointGroup operation to query the configuration of a specified endpoint group that is associated with a custom routing 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:DescribeCustomRoutingEndpointGroup

get

*CustomRoutingEndpointGroup

acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#customroutingendpointgroupId}

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
EndpointGroupId	string	Yes	The ID of the endpoint group to query.	epg-bp1dmlohjjz4kqaua****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the custom routing listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The ID of the endpoint group.	epg-bp1dmlohjjz4kqaua****
Name	string	The name of the endpoint group.	group1
Description	string	The description of the endpoint group.	EndpointGroup
EndpointGroupIpList	array	The list of public IP addresses of the endpoint group.
	string	The list of public IP addresses of the endpoint group.	203.0.XX.XX
EndpointGroupUnconfirmedIpList	array	The list of unconfirmed public IP addresses of the endpoint group that are added after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.
	string	The list of unconfirmed IP addresses of the endpoint group that are added after the Alibaba Cloud Global Accelerator (GA) instance is upgraded.	203.0.XX.XX
EndpointGroupRegion	string	The region ID of the endpoint group.	cn-hangzhou
State	string	The status of the endpoint group. Valid values: init: The endpoint group is being initialized. active: The endpoint group is running as expected. updating: The endpoint group is being updated. deleting: The endpoint group is being deleted.	active
SlsRegion	string	The region of the logs that are created in Simple Log Service.	cn-hangzhou
SlsProjectName	string	The name of the Simple Log Service project.	pn-01
SlsLogStoreName	string	The name of the Simple Log Service Logstore.	lsn-01
AccessLogSwitch	string	The binding status of the access log. Valid values: on: The access log is bound. off: The access log is not bound. binding: The access log is being bound. unbinding: The access log is being unbound.	on
EnableAccessLog	boolean	Indicates whether the access log feature is enabled. true: The access log feature is enabled. false: The access log feature is disabled.	true
ServiceId	string	The ID of the service that manages the managed instance. 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, operations that the user can perform 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 managed policy action. Valid values: Create: Create an instance. Update: Update the current instance. Delete: Delete the current instance. Associate: Reference or be referenced by the current instance. UserUnmanaged: Unmanage the instance. CreateChild: Create a child resource under the current instance.	Update
ChildType	string	The type of the child resource. Valid values: Listener: listener resource. IpSet: acceleration region resource. EndpointGroup: endpoint group resource. ForwardingRule: forwarding rule resource. Endpoint: endpoint resource. EndpointGroupDestination: protocol mapping resource of the endpoint group under the custom routing listener. EndpointPolicy: access policy resource of the endpoint under the custom routing listener. Note This parameter is valid only when Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the managed policy action is managed. Valid values: true: The managed policy action is managed. The user cannot perform the action specified by Action on the managed instance. false: The managed policy action is not managed. The user can perform the action specified by Action on the managed instance.	false

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaua****",
  "Name": "group1",
  "Description": "EndpointGroup",
  "EndpointGroupIpList": [
    "203.0.XX.XX"
  ],
  "EndpointGroupUnconfirmedIpList": [
    "203.0.XX.XX"
  ],
  "EndpointGroupRegion": "cn-hangzhou",
  "State": "active",
  "SlsRegion": "cn-hangzhou",
  "SlsProjectName": "pn-01",
  "SlsLogStoreName": "lsn-01",
  "AccessLogSwitch": "on",
  "EnableAccessLog": true,
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.