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

Queries a custom routing endpoint.

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:DescribeCustomRoutingEndpoint

get

*CustomRoutingEndpoint

acs:ga:{#regionId}:{#accountId}:customroutingendpoint/{#CustomRoutingEndpointId}

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
EndpointId	string	Yes	The ID of the endpoint.	ep-bp1dmlohjjz4kqaun****
EndpointGroup	string	No	The ID of the endpoint group.	epg-bp1j184jhb9i9ubwf****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	String 04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The ID of the associated GA instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the associated listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The ID of the endpoint group that contains this endpoint.	epg-bp14sz7ftcwwjgrdm****
EndpointId	string	The ID of the endpoint.	ep-bp1dmlohjjz4kqaun****
Type	string	The backend service type of the endpoint. Only PrivateSubNet (private CIDR blocks) is supported.	PrivateSubNet
Endpoint	string	The name of the endpoint (vSwitch).	vsw-test01
TrafficToEndpointPolicy	string	The traffic access policy 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
State	string	The status of the endpoint.	active
ServiceId	string	The service ID of the managed instance. Note Valid only when ServiceManaged is true.	ALB
ServiceManaged	boolean	Indicates whether the instance is managed. Valid values: true false	true
ServiceManagedInfos	array<object>	The action policies that users can perform on this managed instance.
	object	The action policies that users can perform on this managed instance.
Action	string	The managed policy action name. Valid values: Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	The child resource type. Valid values: Listener IpSet EndpointGroup ForwardingRule Endpoint EndpointGroupDestination EndpointPolicy Note Valid only when Action is CreateChild.	Listener
IsManaged	boolean	Indicates whether the action is managed. Valid values: true: Users cannot perform this action on the managed instance. false: Users can perform this action on the managed instance.	false

Examples

Success response

JSON format

{
  "RequestId": "String\t04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
  "EndpointId": "ep-bp1dmlohjjz4kqaun****",
  "Type": "PrivateSubNet",
  "Endpoint": "vsw-test01",
  "TrafficToEndpointPolicy": "DenyAll",
  "State": "active",
  "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.