edit-icon download-icon

DescribeLoadBalancerAttribute

Last Updated: Mar 05, 2018

Description

Query the detailed information of an SLB instance according to instance ID.

Request parameter

Name Type Required Description
Action String Yes

The action to perform. Valid value:

DescribeLoadBalancerAttribute

RegionId String Yes

The ID of the region where the Server Load Balancer instance is located. For example: cn-hangzhou

Call the DescribeRegions API to get the list of available regions.

MasterZoneId String No

The ID of the active zone. By default, the SLB cluster in the active zone is used to distribute traffic.

Call the DescribeZone API to get the available zones to use.

SlaveZoneId String No

The ID of the standby zone. The standby zone takes over the traffic distribution only when the SLB cluster in the master zone fails.

Call the DescribeZone API to get the available zones to use.

Response parameter

Name Type Description
RequestId String The ID of the request.
LoadBalancerId String The ID of SLB instance.
RegionId String The ID of the region where the SLB instance is located.
RegionIdAlias String The name of the region where the SLB instance is located.
LoadBalancerName String The name of the SLB instance.
LoadBalancerStatus String

The status of the SLB instance.

  • active

    When the SLB instance in the active status, the listeners in the instance can distribute traffic.

  • inactive

    When the SLB instance in the inactive status, the listeners in the instance cannot distribute traffic any more.

Address String The IP address of the SLB instance
AddressType String The type of the SLB instance address. Valid values:

internet | intranet

NetworkType String The network type of the SLB instance. Valid values:

classic | vpc

VpcId String

The ID of the VPC where the SLB instance is created.

Note: This parameter is returned only when a VPC network SLB instance is created.

VswitchId String

The ID of the VSwitch where the SLB instance is created.

Note: This parameter is returned only when a VPC network SLB instance is created.

CreateTime String The time at which the SLB instance is created.
ListenerPorts List

The list of front-end ports configured in the SLB instance.

  • ListenerPort: The used front-end port.
ListenerPortsAndProtocol List

The list of the front-end ports and protocols configured in the SLB instance.

  • ListenerPort: The used front-end port.
  • ListenerProtocol: The used front-end protocol.
BackendServers List

The list of the backend servers added to the SLB instance.

  • ServerId: The ID of the backend server (ECS instance).
  • Weight: The weight of the backend server.
MasterZoneId String The ID of the active zone of the SLB instance.
SlaveZoneId String The ID of the standby zone of the SLB instance.

Example

Request example

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

Response example

  • XML format

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeLoadBalancerAttributeResponse>
    3. <RequestId>3205F12B-DF50-4615-9F5E-7D40D52CD74F</RequestId>
    4. <CreateTimeStamp>1518143733000</CreateTimeStamp>
    5. <RegionIdAlias>cn-hangzhou</RegionIdAlias>
    6. <BackendServers>
    7. <BackendServer>
    8. <ServerId>i-bp17pmfcz39l7qf3hex4</ServerId>
    9. <Weight>100</Weight>
    10. </BackendServer>
    11. </BackendServers>
    12. <ListenerPorts>
    13. <ListenerPort>443</ListenerPort>
    14. <ListenerPort>80</ListenerPort>
    15. </ListenerPorts>
    16. <InternetChargeType>paybytraffic</InternetChargeType>
    17. <VSwitchId></VSwitchId>
    18. <VpcId></VpcId>
    19. <SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
    20. <NetworkType>classic</NetworkType>
    21. <ListenerPortsAndProtocol>
    22. <ListenerPortAndProtocol>
    23. <ListenerProtocol>tcp</ListenerProtocol>
    24. <ListenerPort>443</ListenerPort>
    25. </ListenerPortAndProtocol>
    26. <ListenerPortAndProtocol>
    27. <ListenerProtocol>tcp</ListenerProtocol>
    28. <ListenerPort>80</ListenerPort>
    29. </ListenerPortAndProtocol>
    30. </ListenerPortsAndProtocol>
    31. <PayType>PayOnDemand</PayType>
    32. <Bandwidth>5120</Bandwidth>
    33. <LoadBalancerName>a8b30bdf00d4111e8a60900163e10659</LoadBalancerName>
    34. <ResourceGroupId>rg-acfntierof5q2nq</ResourceGroupId>
    35. <LoadBalancerId>lb-1ud4syvk9wlwd0gav09uy</LoadBalancerId>
    36. <EndTimeStamp>32493801600000</EndTimeStamp>
    37. <MasterZoneId>cn-hangzhou-b</MasterZoneId>
    38. <ListenerPortsAndProtocal>
    39. <ListenerPortAndProtocal>
    40. <ListenerProtocal>tcp</ListenerProtocal>
    41. <ListenerPort>443</ListenerPort>
    42. </ListenerPortAndProtocal>
    43. <ListenerPortAndProtocal>
    44. <ListenerProtocal>tcp</ListenerProtocal>
    45. <ListenerPort>80</ListenerPort>
    46. </ListenerPortAndProtocal>
    47. </ListenerPortsAndProtocal>
    48. <CreateTime>2018-02-09T02:35:33Z</CreateTime>
    49. <RegionId>cn-hangzhou-dg-a01</RegionId>
    50. <Address>101.37.225.8</Address>
    51. <AddressType>internet</AddressType>
    52. <EndTime>2999-09-08T16:00:00Z</EndTime>
    53. <LoadBalancerStatus>active</LoadBalancerStatus>
    54. </DescribeLoadBalancerAttributeResponse>
  • JSON format

    1. {
    2. "CreateTimeStamp": 1518143733000,
    3. "RegionIdAlias": "cn-hangzhou",
    4. "BackendServers": {
    5. "BackendServer": [
    6. {
    7. "ServerId": "i-bp17pmfcz39l7qf3hex4",
    8. "Weight": 100
    9. }
    10. ]
    11. },
    12. "ListenerPorts": {
    13. "ListenerPort": [
    14. 443,
    15. 80
    16. ]
    17. },
    18. "InternetChargeType": "paybytraffic",
    19. "VSwitchId": "",
    20. "VpcId": "",
    21. "SlaveZoneId": "cn-hangzhou-d",
    22. "NetworkType": "classic",
    23. "ListenerPortsAndProtocol": {
    24. "ListenerPortAndProtocol": [
    25. {
    26. "ListenerProtocol": "tcp",
    27. "ListenerPort": 443
    28. },
    29. {
    30. "ListenerProtocol": "tcp",
    31. "ListenerPort": 80
    32. }
    33. ]
    34. },
    35. "PayType": "PayOnDemand",
    36. "Bandwidth": 5120,
    37. "LoadBalancerName": "a8b30bdf00d4111e8a60900163e10659",
    38. "ResourceGroupId": "rg-acfntierof5q2nq",
    39. "LoadBalancerId": "lb-1ud4syvk9wlwd0gav09uy",
    40. "EndTimeStamp": 32493801600000,
    41. "MasterZoneId": "cn-hangzhou-b",
    42. "ListenerPortsAndProtocal": {
    43. "ListenerPortAndProtocal": [
    44. {
    45. "ListenerProtocal": "tcp",
    46. "ListenerPort": 443
    47. },
    48. {
    49. "ListenerProtocal": "tcp",
    50. "ListenerPort": 80
    51. }
    52. ]
    53. },
    54. "CreateTime": "2018-02-09T02:35:33Z",
    55. "RequestId": "3205F12B-DF50-4615-9F5E-7D40D52CD74F",
    56. "RegionId": "cn-hangzhou-dg-a01",
    57. "Address": "101.37.225.8",
    58. "AddressType": "internet",
    59. "EndTime": "2999-09-08T16:00:00Z",
    60. "LoadBalancerStatus": "active"
    61. }
Thank you! We've received your feedback.