DescribeLoadBalancerAttribute

Last Updated: Aug 29, 2017

Description

Query the Server Load Balancer instance information according to LoadBalancerId. The returned information includes the service address of the Server Load Balancer instance, type of the service address, frontend port list and backend server list of the Server Load Balancer instance.

Request parameter

Name Type Required Description
Action String Yes Name of the operating interface, which is specified in the system. Value :DescribeLoadBalancerAttribute.
MasterZoneId String Yes The ID of the master zone where the instance is created. Use DescribeZone to check the master zone and slave zone of a region. Multi-zone is not supported for FinCloud.
LoadBalancerId String No The unique ID of a Server Load Balancer instance.
SlaveZoneId String No The ID of the slave zone where the instance is created. Use DescribeZone to check the master zone and slave zone of a region. Multi-zone is not supported for FinCloud.
RegionId String Yes The ID of the region.

Return parameter

Name Type Description
Common Parameter See Public Parameters for details.
LoadBalancerId String The unique ID of a Server Load Balancer instance.
RegionId String ID of the Region where the Server Load Balancer instance is located.
RegionIdAlias String The alias of region number.
LoadBalancerName String Alias of a Server Load Balancer instance. If no alias is specified by the user, it is a null string.
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 Service address of the Server Load Balancer instance.
AddressType String Address type, internet or intranet.
NetworkType String Network type of a Server Load Balancer instance. Value: VPC, classic.
VpcId String The ID of the VPC where a Server Load Balancer instance is created. Return value can only be achieved when the network type is VPC.
VswitchId String The ID of the VSwitch where a Server Load Balancer instance is created. Return value can only be achieved when the network type is VPC.
Bandwidth Integer The peak bandwidth to be set when the public network instance is charged by fixed bandwidth.
CreateTime String Creation time of a Server Load Balancer instance.
ListenerPorts List The ports used by the Server Load Balancer instance frontend are listed in the array format. See the following table for details.
ListenerPortsAndProtocol List The ports used by the Server Load Balancer instance frontend are listed in the array format. See the following table for details.
BackendServers List Information of multiple backend servers in the Server Load Balancer instance is returned in the array format. See the following table for details.
MasterZoneId String Master zone ID of the instance.
SlaveZoneId/td> String Slave zone ID of the instance.

Port number used by the Server Load Balancer instance frontend (ListenerPorts)

Name Type Description
ListenerPort String Port used by the Server Load Balancer instance frontend.
ListenerProtocol Integer The protocol used by the frontend of a Server Load Balancer instance.

Backend server information (BackendServers)

Name Type Description
ServerId String Backend server ID (ECS instance ID).
Weight Integer Weight of the backend server.

Example

Request example

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeLoadBalancerAttribute
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &<Common Parameter>

Return example

  • XML format

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeLoadBalancerAttributeResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <LoadBalancerId>139a00604ad-cn-east-hangzhou-01</LoadBalancerId>
    5. <RegionId>cn-east-hangzhou-01</RegionId>
    6. <LoadBalancerName>abc</LoadBalancerName>
    7. <LoadBalancerStatus>active</LoadBalancerStatus>
    8. <Address>42.250.6.36</Address>
    9. <AddressType>internet</AddressType>
    10. <InternetChargeType>paybytraffic</InternetChargeType>
    11. <CreateTime>2014-01-01 00:00:00</CreateTime>
    12. <ListenerPorts>
    13. <ListenerPort>80</ListenerPort>
    14. <ListenerPort>443</ListenerPort>
    15. </ListenerPorts>
    16. <BackendServers>
    17. <BackendServer>
    18. <ServerId>vm-233</ServerId>
    19. <Weight>100</Weight>
    20. </BackendServer>
    21. <BackendServer>
    22. <ServerId>vm-234</ServerId>
    23. <Weight>90</Weight>
    24. </BackendServer>
    25. </BackendServers>
    26. </DescribeLoadBalancerAttributeResponse>
  • JSON format

    1. {
    2. "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "LoadBalancerId": "139a00604ad-cn-east-hangzhou-01",
    4. "RegionId": "cn-east-hangzhou-01",
    5. "LoadBalancerName": "abc",
    6. "LoadBalancerStatus ": "active",
    7. "Address": "42.250.6.36",
    8. "AddressType": "internet",
    9. "InternetChargeType": "paybytraffic",
    10. "CreateTime": "2014-01-01 00:00:00",
    11. "ListenerPorts": {
    12. "ListenerPort": [
    13. 80,
    14. 443
    15. ]
    16. },
    17. "BackendServers": {
    18. "BackendServer": [
    19. {
    20. "ServerId": "vm-233",
    21. "Weight": 100
    22. },
    23. {
    24. "ServerId": "vm-234",
    25. "Weight": 90
    26. }
    27. ]
    28. }
    29. }
Thank you! We've received your feedback.