Queries detailed information about a specified Server Load Balancer (SLB) instance. If the backend server is deployed in a vServer group, you can call the DescribeVServerGroupAttribute operation to query the backend server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLoadBalancerAttribute

The operation that you want to perform.

Set the value to DescribeLoadBalancerAttribute.

LoadBalancerId String Yes lb-bp1b6c719dfa08ex****

The ID of the SLB instance.

RegionId String Yes cn-hangzhou

The ID of the region where the SLB instance is deployed.

You can query the most recent region list from the Regions and zones list or by calling the DescribeRegions operation.

Response parameters

Parameter Type Example Description
LoadBalancerId String lb-bp1o94dp5i6ea****

The ID of the SLB instance.

RegionId String cn-hangzhou

The ID of the region where the SLB instance is deployed.

RegionIdAlias String hangzhou

The alias of the region where the SLB instance is created.

LoadBalancerName String lb-instance-test

The name of the SLB instance.

LoadBalancerStatus String active

The state of the SLB instance. Valid values:

  • inactive: The SLB instance is stopped. SLB instances in the inactive state do not forward traffic.
  • active: The SLB instance is running as expected. Newly created SLB instances are in the active state by default.
  • locked: The SLB instance is locked. SLB instances may be locked by Alibaba Cloud due to overdue payments or other reasons.
Address String 42.XX.XX.6

The IP address of the SLB instance.

AddressType String internet

The type of IP address that the SLB instance uses to provide services.

NetworkType String vpc

The type of network where the SLB instance is deployed.

VpcId String vpc-25dvzy9f8****

The ID of the virtual private cloud (VPC) where the internal-facing SLB instance is deployed.

Bandwidth Integer 5

The maximum bandwidth value of the Internet-facing SLB instance that is billed on a pay-by-bandwidth basis.

CreateTime String 2017-08-31T02:49:05Z

The time when the SLB instance was created.

ListenerPorts List 80

The frontend port that is used by the SLB instance.

ListenerPortsAndProtocol Array of ListenerPortAndProtocol

The frontend ports and protocols that are used by the SLB instance.

ListenerPortAndProtocol
ListenerPort Integer 80

The frontend port that is used by the SLB instance.

ListenerProtocol String https

The frontend protocol that is used by the SLB instance.

Description String The description of the listener.

The description of the port and protocol that are used by the listener.

ForwardPort Integer 443

The port that the listener uses to distribute requests. The port must be open and use the HTTPS protocol.

ListenerForward String on

Indicates whether the listener is enabled to distribute requests.

BackendServers Array of BackendServer

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

BackendServer
ServerId String i-djghr2****

The ID of the backend server.

Weight Integer 90

The weight of the backend server.

Description String BackendServertoReceiveRequests

The description of the backend server.

Type String ecs

The type of the backend server.

MasterZoneId String cn-hangzhou-b

The ID of the primary zone to which the SLB instance belongs.

AddressIPVersion String ipv4

The IP version. Valid values: ipv4 and ipv6.

AutoReleaseTime Long 1513947075000

The timestamp generated when the SLB instance was released.

CreateTimeStamp Long 1504147745000

The timestamp generated when the SLB instance was created.

DeleteProtection String off

Indicates whether deletion protection is enabled for the SLB instance.

Valid values: on and off.

EndTime String 2999-09-08T16:00:00Z

The time when the SLB instance was stopped.

EndTimeStamp Long 32493801600000

The timestamp generated when the SLB instance was suspended.

InternetChargeType String paybybandwidth

The metering method of the Internet-facing SLB instance.

Valid values:

  • paybybandwidth: pay-by-bandwidth
  • paybytraffic (default): pay-by-data-transfer
ListenerPortsAndProtocal Array of ListenerPortAndProtocal

The ports or protocols of the listeners.

ListenerPortAndProtocal
ListenerPort Integer 443

The frontend port that is used by the SLB instance.

ListenerProtocal String http

The frontend protocol that is used by the CLB instance.

LoadBalancerSpec String slb.s1.small

The specification of the SLB instance.

ModificationProtectionReason String ManageInstance

The reason why the configuration read-only mode is enabled. The value must be 1 to 80 characters in length. It must start with a letter and can contain digits, periods (.), underscores (_), and hyphens (-).

Note This parameter is effective only when ModificationProtectionStatus is set to ConsoleProtection.
ModificationProtectionStatus String ConsoleProtection

Indicates whether the configuration read-only mode is enabled for the SLB instance. Valid values:

  • NonProtection: indicates that the configuration read-only mode is disabled. After you disable the configuration read-only mode, the value of ModificationProtectionReason is cleared.
  • ConsoleProtection: indicates that the configuration read-only mode is enabled.
PayType String PrePay

The billing method of the CLB instance. Valid values: PayOnDemand and PrePay.

RenewalCycUnit String Month

Auto-renewal cycle. Valid values: Year and Month. Default value: Month.

This parameter is effective only if RenewalStatus is set to AutoRenewal.

RenewalDuration Integer 1

Auto-renewal duration. This parameter is effective only if RenewalStatus is set to AutoRenewal.

  • PeriodUnit is set to Year: Valid values: 1, 2, and 3.
  • PeriodUnit is set to Month: Valid values: 1, 2, 3, and 6.
RenewalStatus String AutoRenewal

Valid values:

  • AutoRenewal: The system automatically renews the SLB instance.
  • Normal: You must manually renew the SLB instance.
  • NotRenewal: The SLB instance will not be renewed upon expiration. If this option is selected, the system does not send notifications until three days before the expiration date.
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

ResourceGroupId String rg-atstuj3rtop****

The ID of the enterprise resource group.

SlaveZoneId String cn-hangzhou-d

The ID of the secondary zone to which the SLB instance belongs.

VSwitchId String vsw-255ecrwq5****

The ID of the vSwitch to which the internal-facing SLB instance belongs.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeLoadBalancerAttribute
&LoadBalancerId=lb-bp1b6c719dfa08ex*****
&<Common request parameters>

Sample success responses

XML format

<DescribeLoadBalancerAttributeResponse>
  <RenewalDuration>1</RenewalDuration>
  <EndTime>2999-09-08T16:00:00Z</EndTime>
  <Address>42.250.6.**</Address>
  <ResourceGroupId>rg-atstuj3rtop*****</ResourceGroupId>
  <ListenerPortsAndProtocal>
        <ListenerPortAndProtocal>
              <ListenerPort>443</ListenerPort>
              <ListenerProtocal>http</ListenerProtocal>
        </ListenerPortAndProtocal>
  </ListenerPortsAndProtocal>
  <AddressIPVersion>ipv4</AddressIPVersion>
  <LoadBalancerId>lb-bp1o94dp5i6ea*******</LoadBalancerId>
  <ListenerPortsAndProtocol>
        <ListenerPortAndProtocol>
              <ListenerForward>yes</ListenerForward>
              <ListenerPort>443</ListenerPort>
              <Description>Description. </Description>
              <ForwardPort>80</ForwardPort>
              <ListenerProtocol>https</ListenerProtocol>
        </ListenerPortAndProtocol>
  </ListenerPortsAndProtocol>
  <BackendServers>
        <BackendServer>
              <Type>ecs</Type>
              <Description>BackendServerDescription</Description>
              <ServerId>i-djghr2****</ServerId>
              <Weight>90</Weight>
        </BackendServer>
  </BackendServers>
  <ModificationProtectionStatus>ConsoleProtection</ModificationProtectionStatus>
  <LoadBalancerSpec>slb.s2.small</LoadBalancerSpec>
  <NetworkType>vpc</NetworkType>
  <Bandwidth>5</Bandwidth>
  <ModificationProtectionReason>ManagedInstance</ModificationProtectionReason>
  <MasterZoneId>cn-hangzhou-b</MasterZoneId>
  <ListenerPorts>
        <ListenerPort>80</ListenerPort>
  </ListenerPorts>
  <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
  <CreateTime>2017-08-31T02:49:05Z</CreateTime>
  <VSwitchId>vsw-255ecrwq5*****</VSwitchId>
  <RenewalStatus>AutoRenewal</RenewalStatus>
  <RenewalCycUnit>Month</RenewalCycUnit>
  <PayType>PrePay</PayType>
  <SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
  <InternetChargeType>paybybandwidth</InternetChargeType>
  <RegionIdAlias>hangzhou</RegionIdAlias>
  <LoadBalancerName>lb-instance-test</LoadBalancerName>
  <DeleteProtection>off</DeleteProtection>
  <VpcId>vpc-25dvzy9f8*****</VpcId>
  <EndTimeStamp>32493801600000</EndTimeStamp>
  <RegionId>cn-hangzhou</RegionId>
  <AddressType>internet</AddressType>
  <LoadBalancerStatus>active</LoadBalancerStatus>
  <CreateTimeStamp>1504147745000</CreateTimeStamp>
  <AutoReleaseTime>1513947075</AutoReleaseTime>
</DescribeLoadBalancerAttributeResponse>

JSON format

{"RenewalDuration":"1",
"EndTime":"2999-09-08T16:00:00Z",
"Address":"42.250.6.**",
"ResourceGroupId":"rg-atstuj3rtop*****",
"ListenerPortsAndProtocal":
{
    "ListenerPortAndProtocal":
    [
        {
            "ListenerPort":"443",
            "ListenerProtocal":"http"
            }
            ]
            },
            
            "AddressIPVersion":"ipv4",
            "LoadBalancerId":"lb-bp1o94dp5i6ea*******",
            "ListenerPortsAndProtocol":
            {
                "ListenerPortAndProtocol":
            [
                {
                    "ListenerForward":"yes",
                    "ListenerPort":"443",
                    "Description": "ListenerDescription",
                    "ForwardPort":"80",
                    "ListenerProtocol":"https"
                    }
                    ]
                    },
                    "BackendServers":
                    {
                        "BackendServer":
                        [
                            {
                                "Type":"ecs",
                                "Description":"BackendServerDescription",
                                "ServerId":"i-djghr2****",
                                "Weight":"90"
                                }
                                ]
                                },
                                "ModificationProtectionStatus":"ConsoleProtection",
                                "LoadBalancerSpec":"slb.s2.small",
                                "NetworkType":"vpc",
                                "Bandwidth":"5",
                                "ModificationProtectionReason":"ManagedInstance",
                                "MasterZoneId":"cn-hangzhou-b",
                                "ListenerPorts":
                                {
                                    "ListenerPort":"80"
                                    },
                                    "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
                                    "CreateTime":"2017-08-31T02:49:05Z",
                                    "VSwitchId":"vsw-255ecrwq5*****",
                                    "RenewalStatus":"AutoRenewal",
                                    "RenewalCycUnit":"Month",
                                    "PayType":"PrePay",
                                    "SlaveZoneId":"cn-hangzhou-d",
                                    "InternetChargeType":"paybybandwidth",
                                    "RegionIdAlias":"hangzhou",
                                    "LoadBalancerName":"lb-instance-test",
                                    "DeleteProtection":"off",
                                    "VpcId":"vpc-25dvzy9f8*****",
                                    "EndTimeStamp":"32493801600000",
                                    "RegionId":"cn-hangzhou",
                                    "AddressType":"internet",
                                    "LoadBalancerStatus":"active",
                                    "CreateTimeStamp":"1504147745000",
                                    "AutoReleaseTime":"1513947075"}

Error codes

For a list of error codes, visit the API Error Center.