DescribeCustomRoutingEndpointGroup - Global Accelerator - Alibaba Cloud Documentation Center

Queries the information about a specific endpoint group that is associated with a custom routing listener.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:DescribeCustomRoutingEndpointGroup	Read	CustomRoutingEndpointGroup acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#customroutingendpointgroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
EndpointGroupId	string	Yes	The ID of the endpoint group.	epg-bp1dmlohjjz4kqaua****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The GA instance ID.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The custom routing listener ID.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The endpoint group ID.	epg-bp1dmlohjjz4kqaua****
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 addresses.	203.0.XX.XX
EndpointGroupUnconfirmedIpList	array	The endpoint group IP addresses that need to be confirmed after the GA instance is upgraded.
	string	The endpoint group IP addresses that need to be confirmed after the 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 normally. updating: The endpoint group is being updated. deleting: The ACL is being deleted.	active
SlsRegion	string	The region of the logs that are created in Log Service.	cn-hangzhou
SlsProjectName	string	The name of the Log Service project.	pn-01
SlsLogStoreName	string	The name of the Logstore.	lsn-01
AccessLogSwitch	string	Indicates the status of the binding between the Log Service project and the endpoint group. Valid values: on: The endpoint group is bound to the Log Service project. off: The endpoint group is not bound to the Log Service project. binding: The endpoint group is being bound to the Log Service project. unbinding: The endpoint group is being unbound from the Log Service project.	on
EnableAccessLog	boolean	Indicates whether the access log feature is enabled. Valid values: true false	true
ServiceId	string	The ID of the service that manages the GA instance. Note This parameter takes effect only if ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates whether the GA instance is managed. Valid values: true false	true
ServiceManagedInfos	object []	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.
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	Indicates whether the specified actions are managed. Valid values: true: The specified actions are managed, and users cannot perform the specified actions on the managed instance. false: The specified actions are not managed, and users can perform the specified actions on the managed instance.	false

Examples

Sample success responses

JSONformat

{
  "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.

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

Change history

Change time

Summary of changes

Operation

2023-08-15

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.