Docs
api
Global Dynamic Acceleration(PathX)
CreateUGAForwarder

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 NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateUGAForwarder.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. Please refer to the GetProjectList interfaceYes
UGAIdstringAcceleration Configuration Instance IDYes
HTTPHTTP.NintHTTP access to HTTP source forwarding, access port. Disable port 65123.No
HTTPHTTPRS.NintHTTP access to HTTP source forwarding, source station listening portNo
HTTPSHTTP.NintHTTPS access to HTTP back-to-source forwarding, access port. Disable port 65123No
HTTPSHTTPRS.NintHTTPS access and HTTP back-to-source forwarding, back-to-source portNo
HTTPSHTTPS.NintHTTPS access, HTTPS back-to-source forwarding, access port. Disable port 65123.No
HTTPSHTTPSRS.NintHTTPS Access, HTTPS Back-to-source Forwarding, Source Station Listening PortNo
TCP.NintTCP access port, disable port 65123No
TCPRS.NintTCP Source PortNo
UDP.NintUDP access port, disable port 65123No
UDPRS.NintUDP Source PortNo
WSWS.NintWebSocket access to WebSocket back-to-source forwarding, access port. Disable 65123.No
WSWSRS.NintWebSocket access to WebSocket back-to-source forwarding, source station listening portNo
WSSWSS.NintWebSocketS access to WebSocketS back-to-source forwarding, access port. Disable 65123.No
WSSWSSRS.NintWebSocketS access and WebSocketS source forwarding, source station listening port.No
WSSWS.NintWebSocketS access to WebSocket back-to-source forwarding, access port. Disable 65123.No
WSSWSRS.NintWebSocketS access to WebSocket back-to-source forwarding, source station listening port.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No

Example

Request Example

https://api.dezai.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
}