DescribeLoadBalancerAttribute - Developer Guide| Alibaba Cloud Documentation Center

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

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

Return example

XML format

      <?xml version="1.0" encoding="UTF-8"?>
      <DescribeLoadBalancerAttributeResponse>
      <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
      <LoadBalancerId>139a00604ad-cn-east-hangzhou-01</LoadBalancerId>
      <RegionId>cn-east-hangzhou-01</RegionId>
      <LoadBalancerName>abc</LoadBalancerName>
      <LoadBalancerStatus>active</LoadBalancerStatus>
      <Address>42.250.6.36</Address>
      <AddressType>internet</AddressType>
      <InternetChargeType>paybytraffic</InternetChargeType>
      <CreateTime>2014-01-01 00:00:00</CreateTime>
      <ListenerPorts>
          <ListenerPort>80</ListenerPort>
          <ListenerPort>443</ListenerPort>
      </ListenerPorts>
      <BackendServers>
          <BackendServer>
              <ServerId>vm-233</ServerId>
              <Weight>100</Weight>
          </BackendServer>
          <BackendServer>
              <ServerId>vm-234</ServerId>
              <Weight>90</Weight>
          </BackendServer>
      </BackendServers>
      </DescribeLoadBalancerAttributeResponse>

JSON format

  {
      "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
      "LoadBalancerId": "139a00604ad-cn-east-hangzhou-01",
      "RegionId": "cn-east-hangzhou-01",
      "LoadBalancerName": "abc",
      "LoadBalancerStatus ": "active",
      "Address": "42.250.6.36",
      "AddressType": "internet",
      "InternetChargeType": "paybytraffic",
      "CreateTime": "2014-01-01 00:00:00",
      "ListenerPorts": {
          "ListenerPort": [
              80,
              443
          ]
      },
      "BackendServers": {
          "BackendServer": [
              {
                  "ServerId": "vm-233",
                  "Weight": 100
              },
              {
                  "ServerId": "vm-234",
                  "Weight": 90
              }
          ]
      }
  }