DescribeCustomRoutingEndPointTrafficPolicy API reference - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the traffic destination of a specified endpoint by calling the DescribeCustomRoutingEndPointTrafficPolicy operation.

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

get

*CustomRoutingEndpointTrafficPolicy

acs:ga:{#regionId}:{#accountId}:trafficpolicy/{#trafficpolicyId}

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
PolicyId	string	Yes	The ID of the traffic destination to query.	ply-bptest2****
EndpointId	string	No	The ID of the endpoint whose traffic destination you want to query.	ep-bp1d2utp8qqe2a44t****

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 to which the endpoint belongs.	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-bp1bpn0kn908w4nb****
EndpointId	string	The ID of the endpoint to which the traffic destination belongs.	ep-2zewuzypq5e6r3pfh****
Endpoint	string	The name of the vSwitch to which the traffic destination belongs.	vsw-test01
PolicyId	string	The ID of the traffic destination.	ply-bptest2****
Address	string	The IP address of the traffic destination.	10.0.XX.XX
PortRanges	array<object>	The port range of the traffic destination.
	object	The port range over which the traffic destination processes requests.
FromPort	integer	The start port of the port range over which the traffic destination processes requests.	80
ToPort	integer	The end port of the port range over which the traffic destination processes requests.	80
State	string	The status of the traffic destination. Valid values: init: being initialized. active: Normal. updating: being updated. deleting: being deleted.	active
ServiceId	string	The ID of the service that manages the 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: creates an instance. Update: updates the current instance. Delete: deletes the current instance. Associate: references or is referenced by the current instance. UserUnmanaged: unmanages the instance. CreateChild: creates 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 a custom routing listener. EndpointPolicy: traffic policy resource of the endpoint under a 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 operation specified by Action on the managed instance. false: The managed policy action is not managed. The user can perform the operation 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-bp1bpn0kn908w4nb****",
  "EndpointId": "ep-2zewuzypq5e6r3pfh****",
  "Endpoint": "vsw-test01",
  "PolicyId": "ply-bptest2****",
  "Address": "10.0.XX.XX",
  "PortRanges": [
    {
      "FromPort": 80,
      "ToPort": 80
    }
  ],
  "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.