ListCustomRoutingEndpoints - Global Accelerator - Alibaba Cloud Documentation Center

Queries the configurations of an endpoint.

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:ListCustomRoutingEndpoints	list	CustomRoutingEndpoint acs:ga:*:{#accountId}:ga/{#gaId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
AcceleratorId	string	Yes	The GA instance ID.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	The listener ID.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	No	The endpoint group ID.	epg-bp16jdc00bhe97sr5****

Response parameters

Parameter	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.	10
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Endpoints	array<object>	The information about the endpoints.
	object
AcceleratorId	string	The ID of the GA instance with which the endpoint is associated.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the listener to which the endpoint belongs.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The ID of the endpoint group to which the endpoint belongs.	epg-bp16jdc00bhe97sr5****
EndpointId	string	The endpoint ID.	ep-bp14sz7ftcwwjgrdm****
Type	string	The backend service type of the endpoint. Only PrivateSubNet may be returned, which indicates a private CIDR block.	PrivateSubNet
Endpoint	string	The name of the vSwitch that is specified as an endpoint.	vsw-test01
TrafficToEndpointPolicy	string	The access policy of traffic that is destined for the endpoint. Valid values: AllowAll: allows all traffic to the endpoint. DenyAll: denies all traffic to the endpoint. AllowCustom: allows traffic only to specified destinations.	DenyAll
ServiceId	string	The ID of the service that manages the GA instance. Note This parameter is valid only if ServiceManaged is set to True.	ALB
ServiceManaged	boolean	Indicates whether the GA instance is managed. Valid values: true false	true
ServiceManagedInfos	array<object>	The actions that users can perform on the managed instance. Note This parameter is valid only if ServiceManaged is set to True. Users can perform only specific actions on a managed instance.
	object
Action	string	The name of the action performed 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 is valid 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 resource. false: The specified actions are not managed, and users can perform the specified actions on the managed resource.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 10,
  "PageSize": 10,
  "PageNumber": 1,
  "Endpoints": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "Type": "PrivateSubNet",
      "Endpoint": "vsw-test01",
      "TrafficToEndpointPolicy": "DenyAll",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.	No permissions.

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

Change history

Change time	Summary of changes	Operation
2024-07-11	The Error code has changed	View Change Details
2023-07-20	The internal configuration of the API is changed, but the call is not affected	View Change Details