Get traditional load balancing information - DescribeULBSimple
Overview
Retrieve CLB Information
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is DescribeULBSimple. | 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 |
| Offset | int | Data offset, default is 0 | No |
| Limit | int | Data pagination value, default is 10000 | No |
| ULBId | string | The 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 |
| VPCId | string | VPC that CLB belongs to | No |
| SubnetId | string | Subnet ID to which CLB belongs | No |
| BusinessId | string | Business Group ID to which CLB belongs | 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 |
| TotalCount | int | Total number of qualified CLB | Yes |
| DataSet | array[ULBSimpleSet] | CLB List, each parameter details can be found in ULBSimpleSet | Yes |
Data Model
ULBSimpleSet
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| ListenType | string | ULB Listener Type, enumeration values: RequestProxy, request proxy; PacketsTransmit, packet forwarding; Comprehensive, compatible; Pending, undefined | Yes |
| IPVersion | string | The IP type provided by ULB service. Enumerated values, "IPv4", "IPv6". The default is "IPv4". | Yes |
| SnatIps | array[string] | Backward proxy IP of ULB, only returns when there is a proxy IP No | No |
| ULBId | string | Resource ID of ULB | No |
| Name | string | Resource Name of ULB | No |
| Tag | string | Business Group Name of Load Balancing | No |
| Remark | string | Remarks on Load Balancing | No |
| CreateTime | int | Creation time of ULB, in Unix Timestamp format | No |
| VPCId | string | The ID of the VPC where the ULB is located | No |
| SubnetId | string | When ULB is in InnerMode, the subnet ID to which ULB belongs. | No |
| BusinessId | string | Business Group ID to which ULB belongs | No |
| PrivateIP | string | The internal IP of ULB, this value is empty when ULBType is OuterMode | No |
| BandwidthType | int | Bandwidth type, enumeration values are: 0, non-shared bandwidth; 1, shared bandwidth. | No |
| Bandwidth | int | Bandwidth | No |
| IPSet | array[ULBIPSet] | Detailed information list of ULB, see ULBIPSet for specific structure. | No |
| VServerCount | int | Number of vserver under ULB | No |
| ULBType | string | Type of ULB (InnerMode or OuterMode) | No |
| FirewallSet | array[FirewallSet] | Firewall Information, see the specific structure below in FirewallSet | No |
| EnableLog | int | Is the ULB log function enabled? 0, Off; 1, On | No |
| LogSet | LoggerSet | Log function related information, only returned when EnableLog is true, see LoggerSet structure below. | No |
| WAFMode | string | WAF 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 |
ULBIPSet
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| OperatorName | string | Operator information for Elastic IP, enumeration values are: Bgp: BGP IP International: International IP | No |
| EIP | string | Elastic IP Address | No |
| EIPId | string | Elastic IP ID | No |
| BandwidthType | int | The bandwidth type of Elastic IP, enumeration value: 1 indicates shared bandwidth, 0 ordinary bandwidth type (not yet open to the public) | No |
| Bandwidth | int | Bandwidth value of Elastic IP (not yet open to the public) | No |
FirewallSet
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| FirewallName | string | Firewall Name | No |
| FirewallId | string | Firewall ID | No |
LoggerSet
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| BucketName | string | ULB log upload bucket | No |
| TokenID | string | TokenID of the token used to upload to the bucket | No |
| TokenName | string | Name of the bucket's token | No |
Example
Request Example
https://api.surfercloud.com/?Action=DescribeULBSimple
&Region=NkZeYzgW
&ProjectId=COkbjaiz
&Offset=1
&Limit=RCMgySOS
&ULBId=eqSdcAVR
&VPCId=hDOcNuBP
&SubnetId=GbnHwPJO
&BusinessId=jWjuaUUBResponse Example
None yet.
