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 Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is CreateULB . | 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 |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
ULBName | string | The name of the load balancer, the default value is 'ULB'. | No |
Tag | string | Business Group | No |
Remark | string | Note | No |
OuterMode | string | Is the created CLB in public network mode? By default, it is in public network mode. | No |
InnerMode | string | Is the created CLB in internal network mode? | No |
ChargeType | string | Payment method, enumeration values are: Year, pay yearly; Month, pay monthly; Dynamic, pay hourly. | No |
VPCId | string | The 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 |
SubnetId | string | The subnet ID to which the CLB belongs, if not passed, one will be randomly selected. | No |
BusinessId | string | The Business Group ID to which the CLB belongs, if not passed, the default Business Group will be used. | No |
FirewallId | string | Firewall ID, if not passed, it will not bind to the firewall by default. | No |
ListenType | string | CLB 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 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 |
ULBId | string | Id of the traditional load balancing instance | No |
IPv6AddressId | string | IPv6 Address Id | No |
Example
Request Example
https://api.surfercloud.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"
}