Docs
api
Load Balance(ULB)
CreateULB

Create Traditional Load Balancer ULB - CreateULB

Overview

Create a traditional load balancing instance, you can choose between internal network or external network.

ℹ️ When both OuterMode and InnerMode are set to Yes, OuterMode takes precedence. After setting InnerMode to Yes, a SubnetId needs to be passed to represent the subnet where the CLB is located.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateULB.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
ULBNamestringThe name of the load balancer, the default value is 'ULB'.No
TagstringBusiness GroupNo
RemarkstringNoteNo
OuterModestringIs the created CLB in public network mode? By default, it is in public network mode.No
InnerModestringIs the created CLB in internal network mode?No
ChargeTypestringPayment method, enumeration values are: Year, pay yearly; Month, pay monthly; Dynamic, pay hourly.No
VPCIdstringThe ID of the VPC where the CLB is located. If not passed, the default VPC will be used. If not passed and there is no default VPC, the interface will report an error.No
SubnetIdstringThe subnet ID to which the CLB belongs, if not passed, one will be randomly selected.No
BusinessIdstringThe Business Group ID to which the CLB belongs, if not passed, the default Business Group will be used.No
FirewallIdstringFirewall ID, if not passed, it will not bind to the firewall by default.No
ListenTypestringCLB Listener Type, the default for public network CLB is RequestProxy, and for private network ULB is PacketsTransmit. Enumeration values: RequestProxy, request proxy; PacketsTransmit, packet forwarding.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
ULBIdstringId of the traditional load balancing instanceNo
IPv6AddressIdstringIPv6 Address IdNo

Example

Request Example

https://api.ucloud-global.com/?Action=CreateULB
&Region=cn-bj2
&ProjectId=project-XXXXX
&ULBName=test
&OuterMode=Yes
&ChargeType=Month
&VPCId=vnet-XXXXX
&SubnetId=subnet-XXXXX
&Tag=test
&FirewallId=wXfLAbgy

Response Example

{
  "Action": "CreateULBResponse",
  "IPv6AddressId": "LTPlnlOm",
  "RetCode": 0,
  "ULBId": "ulb-XXXXX"
}