ListCustomRoutingPortMappingsByDestination - Global Accelerator

Queries the port mapping table of a specified backend instance 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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	string	No	The number of the page to return. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
EndpointId	string	Yes	The ID of the endpoint to which the backend instance belongs.	ep-bp16jdc00bhe97sr5****
DestinationAddress	string	Yes	The service IP address of the backend instance.	10.0.XX.XX

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	String 04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
PortMappings	array<object>	Details about the port mapping table.
	object
AcceleratorId	string	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the listener.	ga-bp1odcab8tmno0hdq****
EndpointGroupId	string	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****
EndpointId	string	The ID of the endpoint.	ep-bp14sz7ftcwwjgrdm****
EndpointGroupRegion	string	The ID of the region in which the endpoint group resides.	us-west-1
Vswitch	string	The name of the endpoint (vSwitch).	vsw-test01
AcceleratorPort	integer	The acceleration port.	3000
Protocols	array	The protocol of the backend service. tcp: TCP udp: UDP
	string		tcp
DestinationTrafficState	string	The access policy of traffic for the backend instance. allow: allows traffic to the backend instance. deny: denies all traffic to the backend instance.	allow
DestinationSocketAddress	object	The service IP address and port of the backend instance.
IpAddress	string	The service IP address of the backend instance.	10.0.XX.XX
Port	integer	The service port of the backend instance.	443

Examples

Sample success responses

JSONformat

{
  "RequestId": "String\t04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "PortMappings": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "ga-bp1odcab8tmno0hdq****",
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointGroupRegion": "us-west-1",
      "Vswitch": "vsw-test01",
      "AcceleratorPort": 3000,
      "Protocols": [
        "tcp"
      ],
      "DestinationTrafficState": "allow",
      "DestinationSocketAddress": {
        "IpAddress": "10.0.XX.XX",
        "Port": 443
      }
    }
  ]
}

Error codes

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