edit-icon download-icon

DescribeLoadBalancers

Last Updated: Apr 04, 2018

Description

Query all LoadBalancer lists.

Parameters such as LoadBalancerId, AddressType, InternetChargeType and ServerId can be used as query criteria. If none of the preceding query criteria is used as a filter, all LoadBalancers owned by the user will be returned.

Request parameter

Name Type Required Description
Action String Yes Name of the operating interface, which is specified in the system. Value: DescribeLoadBalancers.
RegionId String Yes ID of the Region where the Server Load Balancer instance is located.
LoadBalancerId String No The Server Load Balancer instance ID is used as a filter, and multivalued query is supported. Value:Multiple parameters can be input and separated by ”,”. Default:None. When parameter is not set, it means that the parameter is not used as the filtration criteria.
LoadBalancerName String No The Server Load Balancer instance Name is used as a filter, and multivalued query is supported. Value:Multiple parameters can be input and separated by ”,”. Default:None. When parameter is not set, it means that the parameter is not used as the filtration criteria.
AddressType String No The Address type is used as a filter. Value: internet / intranet. Default: None. When the parameter is not set, it means that the parameter is not used as the filtration criteria.
NetworkType String No The charging mode of the public network instance is used as filter.
VpcId String No The VPC ID of the Server Load Balancer instance.

Value: wrr/wlc

Default: wrr.

VswitchId String No Vswitchid of the Server Load Balancer instance.
Address String No Service address of the Server Load Balancer instance.
InternetChargeType String No The charging mode of the public network instance is used as filter. Value: paybybandwidth / paybytrafficDefault: None. When the parameter is not set, it means that the parameter is not used as the filtration criteria.
ServerId String No The backend server ID (ECS instance ID) is used as a filter. If the criterion is adopted, only the Server Load Balancer instance attached with this server will be returned. Value: ID of an ECS instance. Default: None. When the parameter is not set, it means that the parameter is not used as the filtration criteria.
MasterZoneId String No The master zone ID of the instance. Use DescribeZone to see master/slave zones in a region. Multi-zone is not supported for FinCloud.
SlaveZoneId String No The slave zone ID of the instance. Use DescribeZone to see master/slave zones in a region. Multi-zone is not supported for FinCloud.
Tags String No The Tag list to be added. Value: a Json string, the structure is a JsonList. In a request, the maximum number of elements in a List is 10. The structure of List element are as follows.

Return parameter

Name Type Description
Common Parameter For more information, see Common parameters.
LoadBalancers List The Server Load Balancer instance list is returned in the array format. See the following table.

The Server Load Balancer instance list (LoadBalancers)

Name Type Description
LoadBalancerId String The unique ID of a Server Load Balancer instance.
LoadBalancerName String Alias of an Server Load Balancer instance
LoadBalancerStatus String The status of the Server Load Balancer instance, inactive, active or locked. The locked status indicates the instance is subject to arrearage or locked by Alibaba Cloud, so renew it or contact Alibaba Cloud to unlock it.
Address String The service address of the SLB instance.
RegionId String The ID of the region.
RegionIdAlias String The alias of the region, which is the same with the return parameter of DescribeRegions.
AddressType String Address type of the SLB instance.
VSwitchId String The VSwitch ID of the SLB instance.
VpcId String The VPC ID of the SLB instance.
NetworkType String The network type of the SLB instance. VPC or classic.
Bandwidth String The peak bandwidth to be set when the public network instance is charged by fixed bandwidth.
CreateTime String The create time of the SLB instance.
MasterZoneId String The master zone ID of the instance.
SlaveZoneId String The slave zone ID of the instance.

Example

Request example

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeLoadBalancers
  3. &RegionId=cn-east-hangzhou-01
  4. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01, 282b00102ac-cn-east-hangzhou-01&<common request parameter>

Return example

  • XML format

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeLoadBalancersResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <LoadBalancers>
    5. <LoadBalancer>
    6. <LoadBalancerId>139a00604ad-cn-east-hangzhou-01</LoadBalancerId>
    7. <LoadBalancerName>abc</LoadBalancerName>
    8. <Address>100.98.28.56</Address>
    9. <AddressType>intranet</AddressType>
    10. <RegionId>cn-east-hangzhou-01</RegionId>
    11. <VSwitchId>vsw-255ecrwq4</VSwitchId>
    12. <VpcId>vpc-25dvzy9f9</VpcId>
    13. <NetworkType>vpc</NetworkType>
    14. <LoadBalancerStatus>active</LoadBalancerStatus>
    15. </LoadBalancer>
    16. <LoadBalancer>
    17. <LoadBalancerId>282b00102ac-cn-east-hangzhou-01</LoadBalancerId>
    18. <LoadBalancerName>def</LoadBalancerName>
    19. <Address>100.98.28.55</Address>
    20. <AddressType>intranet</AddressType>
    21. <RegionId>cn-east-hangzhou-01</RegionId>
    22. <VSwitchId>vsw-255ecrwq5</VSwitchId>
    23. <VpcId>vpc-25dvzy9f8</VpcId>
    24. <NetworkType>vpc</NetworkType>
    25. <LoadBalancerStatus>active</LoadBalancerStatus>
    26. </LoadBalancer>
    27. </LoadBalancers>
    28. </DescribeLoadBalancersResponse>
  • JSON format

    1. {
    2. "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "LoadBalancers": {
    4. "LoadBalancer": [
    5. {
    6. "LoadBalancerId": "139a00604ad-cn-east-hangzhou-01",
    7. "LoadBalancerName": "abc",
    8. "Address": "100.98.28.56",
    9. "AddressType": "intranet",
    10. "RegionId": "cn-east-hangzhou-01",
    11. "VSwitchId": "vsw-255ecrwq4",
    12. "VpcId": "vpc-25dvzy9f9",
    13. "NetworkType": "vpc",
    14. "LoadBalancerStatus ": "active"
    15. },
    16. {
    17. "LoadBalancerId": "282b00102ac-cn-east-hangzhou-01",
    18. "LoadBalancerName": "def",
    19. "Address": "100.98.28.55",
    20. "AddressType": "intranet",
    21. "RegionId": "cn-east-hangzhou-01",
    22. "VSwitchId": "vsw-255ecrwq5",
    23. "VpcId": "vpc-25dvzy9f8",
    24. "NetworkType": "vpc",
    25. "LoadBalancerStatus ": "active"
    26. }
    27. ]
    28. }
    29. }
Thank you! We've received your feedback.