Create Acceleration Instance Forwarder - CreateUGAForwarder

Overview

Create an acceleration instance forwarder, supporting HTTPS access to HTTPS back to source, HTTPS access to HTTP back to source, HTTP access to HTTP back to source, TCP access to TCP back to source, UDP access to UDP back to source, supporting WSS access to WSS back to source, WSS access to WS back to source, WS access to WS back to source.

💡 Currently, UGA supports both layer 4 and layer 7 access ports using the same acceleration domain name. Therefore, the TCP protocol access port cannot be the same as the HTTP(s) protocol access port; if you need to switch from TCP acceleration to HTTP acceleration, please first use the DeleteUGAForwarder interface to delete the existing TCP port acceleration and then use CreateUGAForwarder to add a layer 7 acceleration port; modifying the source port also requires deleting the existing port acceleration and adding a new one.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `CreateUGAForwarder`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. Please refer to the GetProjectList interface	Yes
UGAId	string	Acceleration Configuration Instance ID	Yes
HTTPHTTP.N	int	HTTP access to HTTP source forwarding, access port. Disable port 65123.	No
HTTPHTTPRS.N	int	HTTP access to HTTP source forwarding, source station listening port	No
HTTPSHTTP.N	int	HTTPS access to HTTP back-to-source forwarding, access port. Disable port 65123	No
HTTPSHTTPRS.N	int	HTTPS access and HTTP back-to-source forwarding, back-to-source port	No
HTTPSHTTPS.N	int	HTTPS access, HTTPS back-to-source forwarding, access port. Disable port 65123.	No
HTTPSHTTPSRS.N	int	HTTPS Access, HTTPS Back-to-source Forwarding, Source Station Listening Port	No
TCP.N	int	TCP access port, disable port 65123	No
TCPRS.N	int	TCP Source Port	No
UDP.N	int	UDP access port, disable port 65123	No
UDPRS.N	int	UDP Source Port	No
WSWS.N	int	WebSocket access to WebSocket back-to-source forwarding, access port. Disable 65123.	No
WSWSRS.N	int	WebSocket access to WebSocket back-to-source forwarding, source station listening port	No
WSSWSS.N	int	WebSocketS access to WebSocketS back-to-source forwarding, access port. Disable 65123.	No
WSSWSSRS.N	int	WebSocketS access and WebSocketS source forwarding, source station listening port.	No
WSSWS.N	int	WebSocketS access to WebSocket back-to-source forwarding, access port. Disable 65123.	No
WSSWSRS.N	int	WebSocketS access to WebSocket back-to-source forwarding, source station listening port.	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No

Example

Request Example

https://api.surfercloud.com/?Action=CreateUGAForwarder
&ProjectId=org-xxxx
&UGAId=uga-xxxx
&HTTPHTTP.n=80
&HTTPHTTPRS.n=80
&HTTPSHTTP.n=443
&HTTPSHTTPRS.n=80
&TCP.n=22
&TCPRS.n=22
&WSWS.n=3
&WSWSRS.n=9
&WSSWSS.n=7
&WSSWSSRS.n=7
&WSSWS.n=6
&WSSWSRS.n=9

Response Example

{
  "Action": "CreateUGAForwarderResponse",
  "Message": "",
  "RetCode": 0
}

CreatePathXSSL CreateUGAInstance