Load Balance(ULB)

Get traditional load balancing information - DescribeULBSimple


Retrieve CLB Information


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeULBSimple.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
OffsetintData offset, default is 0No
LimitintData pagination value, default is 10000No
ULBIdstringThe Id of the traditional load balancing instance. If specified, the information of the specified traditional load balancing instance will be returned; if not specified, the information of all traditional load balancing instances in the current data center will be returned.No
VPCIdstringVPC that CLB belongs toNo
SubnetIdstringSubnet ID to which CLB belongsNo
BusinessIdstringBusiness Group ID to which CLB belongsNo

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
TotalCountintTotal number of qualified CLBYes
DataSetarray[ULBSimpleSet]CLB List, each parameter details can be found in ULBSimpleSetYes

Data Model


Field NameTypeDescription InformationRequired
ListenTypestringULB Listener Type, enumeration values: RequestProxy, request proxy; PacketsTransmit, packet forwarding; Comprehensive, compatible; Pending, undefinedYes
IPVersionstringThe IP type provided by ULB service. Enumerated values, "IPv4", "IPv6". The default is "IPv4".Yes
SnatIpsarray[string]Backward proxy IP of ULB, only returns when there is a proxy IP
ULBIdstringResource ID of ULBNo
NamestringResource Name of ULBNo
TagstringBusiness Group Name of Load BalancingNo
RemarkstringRemarks on Load BalancingNo
CreateTimeintCreation time of ULB, in Unix Timestamp formatNo
VPCIdstringThe ID of the VPC where the ULB is locatedNo
SubnetIdstringWhen ULB is in InnerMode, the subnet ID to which ULB belongs.No
BusinessIdstringBusiness Group ID to which ULB belongsNo
PrivateIPstringThe internal IP of ULB, this value is empty when ULBType is OuterModeNo
BandwidthTypeintBandwidth type, enumeration values are: 0, non-shared bandwidth; 1, shared bandwidth.No
IPSetarray[ULBIPSet]Detailed information list of ULB, see ULBIPSet for specific structure.No
VServerCountintNumber of vserver under ULBNo
ULBTypestringType of ULB (InnerMode or OuterMode)No
FirewallSetarray[FirewallSet]Firewall Information, see the specific structure below in FirewallSetNo
EnableLogintIs the ULB log function enabled? 0, Off; 1, OnNo
LogSetLoggerSetLog function related information, only returned when EnableLog is true, see LoggerSet structure below.No
WAFModestringWAF function status, enumeration type: Unavailable: Unable to create WAF; NoWAF: WAF not bound; Intranet: Intranet back-to-source WAF; Extranet: Extranet back-to-source WAF.No


Field NameTypeDescription InformationRequired
OperatorNamestringOperator information for Elastic IP, enumeration values are: Bgp: BGP IP International: International IPNo
EIPstringElastic IP AddressNo
EIPIdstringElastic IP IDNo
BandwidthTypeintThe bandwidth type of Elastic IP, enumeration value: 1 indicates shared bandwidth, 0 ordinary bandwidth type (not yet open to the public)No
BandwidthintBandwidth value of Elastic IP (not yet open to the public)No


Field NameTypeDescription InformationRequired
FirewallNamestringFirewall NameNo
FirewallIdstringFirewall IDNo


Field NameTypeDescription InformationRequired
BucketNamestringULB log upload bucketNo
TokenIDstringTokenID of the token used to upload to the bucketNo
TokenNamestringName of the bucket's tokenNo


Request Example

Response Example

None yet.

  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.