Create UPath - CreateUPath

Overview

Create UPath

💡 The range of the LineId parameter is obtained from the DescribePathXLineConfig interface. After the resource is created, automatic renewal will be enabled. If the remaining balance in the account is insufficient, arrears orders will be generated until the resource is reclaimed. Please note that for post-paid resources, daily traffic costs are settled daily. If the deduction fails for more than seven days, the bandwidth will be limited to 1mbps.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `CreateUPath`.	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 GetProjectList interface	Yes
Name	string	Name, for easy memory and differentiation	Yes
LineId	string	The selected line, provided by the DescribePathXLineConfig interface.	Yes
Bandwidth	int	When PostPaid is false, this value is the prepaid fixed bandwidth; when PostPaid is true, this value is the postpaid guaranteed bandwidth, the larger the guaranteed bandwidth, the larger the available upper limit bandwidth. The minimum is 1Mbps, and the maximum bandwidth is obtained from the DescribePathXLineConfig interface. You can contact the product team for the maximum bandwidth.	Yes
ChargeType	string	Billing mode, default is 'Month' for monthly charges, optional range ['Month','Year','Dynamic']	No
Quantity	int	Purchase cycle, when ChargeType is 'Month', Quantity defaults to 0 representing purchase until the end of the month, for 'Hourly' and 'Yearly' payments this parameter must be greater than 0.	No
PostPaid	boolean	Whether to enable post-payment, the default is false, do not enable post-payment. Post-payment cannot be enabled when ChargeType is Dynamic.	No
PathType	string	private: Dedicated Line; public: Overseas SD-WAN. The default is private.	No
CouponId	string	Coupon Id	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
PathId	string	Acceleration Line Instance Id	Yes

Example

Request Example

https://api.surfercloud.com/?Action=CreateUPath
&Name=test
&LineId=line_cn_afr-nigeria
&Bandwidth=1
&ChargeType=Month
&Quantity=0
&CouponId=
&PostPaid=true
&PathType=HAqxnycJ

Response Example

{
  "Action": "CreateUPathResponse",
  "RetCode": 0,
  "UPathId": "upath-xxx"
}

CreateUGAInstance DeleteGlobalSSHInstance