Create Global Acceleration Configuration - CreateUGAInstance

Overview

Create Global Acceleration Configuration

💡 UGA, as an acceleration configuration instance, follows the billing cycle of the bound UPath resources. The resources will automatically renew upon expiration, and if the account balance is insufficient, an overdue order will be generated until the resources are reclaimed. If no line is bound, no fees will be charged for the acceleration configuration.

ℹ️ After the acceleration configuration is created, you need to call the UGABindUPath interface to use it.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `CreateUGAInstance`.	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, such as org-xxxx. Please refer to the GetProjectList interface.	Yes
Name	string	Acceleration Configuration Instance Name	Yes
IPList	string	Acceleration source IP, multiple IPs are separated by English half-width commas (,); IPList and Domain are required to fill one of the two.	No
Domain	string	Acceleration source domain name, IPList and Domain, one of the two must be filled in.	No
TCP.N	string	TCP port number, deprecated. Please use CreateUGAForwarder API to create a port	No
UDP.N	string	UDP port number, deprecated. Please use CreateUGAForwarder API to create a 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
UGAId	string	Acceleration Configuration ID	Yes
CName	string	Accelerated Domain Name: Users can CName their business domain names to this domain name. Note: The accelerated domain name cannot resolve the IP when the line is not bound.	No

Example

Request Example

https://api.surfercloud.com/?Action=CreateUGAInstance
&Name=test
&Domain=google.com

Response Example

{
  "Action": "CreateUGAInstanceResponse",
  "CName": "xxx.ucloudgda.com",
  "Message": "",
  "RetCode": 0,
  "UGAId": "uga-xxxx"
}

CreateUGAForwarder CreateUPath