DescribeCustomRoutingEndPointTrafficPolicy - Global Accelerator

Queries a traffic destination 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:DescribeCustomRoutingEndPointTrafficPolicy	get	CustomRoutingEndpointTrafficPolicy acs:ga:{#regionId}:{#accountId}:trafficpolicy/{#trafficpolicyId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The operation that you want to perform. Set the value to DescribeCustomRoutingEndPointTrafficPolicy.	cn-hangzhou
PolicyId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	ply-bptest2****
EndpointId	string	No	The ID of the traffic policy to be queried.	ep-bp1d2utp8qqe2a44t****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the endpoint to which the traffic destination belongs.	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The ID of the request.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the GA instance to which the endpoint belongs.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupId	string	The ID of the listener to which the endpoint belongs.	epg-bp1bpn0kn908w4nb****
EndpointId	string	The ID of the endpoint group to which the endpoint belongs.	ep-2zewuzypq5e6r3pfh****
Endpoint	string	The ID of the endpoint to which the traffic policy belongs.	vsw-test01
PolicyId	string	The name of the vSwitch to which the traffic policy belongs.	ply-bptest2****
Address	string	The ID of the traffic policy.	10.0.XX.XX
PortRanges	array<object>	The IP address of the traffic policy.
	object	The port range of the traffic policy.
FromPort	integer	The first port of the port range used by the traffic destination to process requests.	80
ToPort	integer	The last port of the port range used by the traffic destination to process requests.	80
State	string	The status of the traffic destination. init: being initialized. active: running as expected. updating: being updated. deleting: being deleted.	active
ServiceId	string	The ID of the service that manages the instance. Note This parameter is returned only if the value of ServiceManaged is true.	ALB
ServiceManaged	boolean	Indicates whether the 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 returned only if the value of ServiceManaged is true. Users can perform only specific actions on a managed instance.
	object	A list of action policies that users can execute on this managed instance.
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 that is associated with a custom routing listener. EndpointPolicy: traffic policy of an endpoint that is associated with a custom routing listener. Note This parameter takes effect only if the value of Action is CreateChild.	Listener
IsManaged	boolean	Indicates whether the specified actions are managed. 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-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.

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

Change history

Change time	Summary of changes	Operation
2023-04-20	The Error code has changed	View Change Details