Queries detailed information about a specified Classic Load Balancer (CLB) instance.

Note If the backend servers are 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 CLB instance.

RegionId String Yes cn-hangzhou

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

You can call the DescribeRegions operation to query the most recent region list.

Response parameters

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

The ID of the CLB instance.

RegionId String cn-hangzhou

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

RegionIdAlias String hangzhou

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

LoadBalancerName String lb-instance-test

The name of the CLB instance.

LoadBalancerStatus String active

The status of the CLB instance. Valid values:

  • inactive: The CLB instance is stopped. CLB instances in the inactive state do not forward traffic.
  • active: The CLB instance is running as expected. Newly created CLB instances are in the active state by default.
  • locked: The CLB instance is locked. CLB 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 CLB instance.

AddressType String internet

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

NetworkType String vpc

The type of network where the CLB instance is deployed.

VpcId String vpc-25dvzy9f8****

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

Bandwidth Integer 5

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

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

The time when the CLB instance was created.

ListenerPorts List 80

The frontend ports that are used by the CLB instance.

ListenerPortsAndProtocol Array of ListenerPortAndProtocol

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

ListenerPortAndProtocol
ListenerPort Integer 80

The frontend port that is used by the CLB instance.

ListenerProtocol String https

The frontend protocol that is used by the CLB instance.

Description String ListenerDescription

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 HTTPS.

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 CLB 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 CLB instance belongs.

AddressIPVersion String ipv4

The IP version of the CLB instance. Valid values: ipv4 and ipv6.

AutoReleaseTime Long 1513947075000

The timestamp generated when the CLB instance was released.

CreateTimeStamp Long 1504147745000

The timestamp generated when the CLB instance was created.

DeleteProtection String off

Indicates whether deletion protection is enabled for the CLB instance.

Valid values: on and off.

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

The time when the CLB instance was stopped.

EndTimeStamp Long 32493801600000

The timestamp generated when the CLB instance was stopped.

InternetChargeType String paybytraffic

The billing method of the Internet-facing CLB instance.

The value is set to

  • PayOnDemand (default): pay-as-you-go
ListenerPortsAndProtocal Array of ListenerPortAndProtocal

The ports or protocols of the listeners.

ListenerPortAndProtocal
ListenerPort Integer 443

The frontend port that is used by the CLB instance.

ListenerProtocal String http

The frontend protocol that is used by the CLB instance.

LoadBalancerSpec String slb.s1.small

The specification of the CLB 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 required only when ModificationProtectionStatus is set to ConsoleProtection.
ModificationProtectionStatus String ConsoleProtection

Indicates whether the configuration read-only mode is enabled for the CLB 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 PayOnDemand

The billing method of the CLB instance. The value is set to

  • PayOnDemand (default): pay-as-you-go
RenewalCycUnit String Month

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

Note This parameter is valid only if you create a subscription CLB instances on the Alibaba Cloud China site. In this case, the PayType parameter must be set to PrePay and the RenewalStatus parameter must be set to AutoRenewal.
RenewalDuration Integer 1

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

  • Valid values when the PeriodUnit parameter is set to Year: 1, 2, and 3.
  • Valid values when the PeriodUnit parameter is set to Month: 1, 2, 3, and 6.
    Note This parameter is valid only when you create a subscription CLB instance on the Alibaba Cloud China site. In this case, the PayType parameter must be set to PrePay.
RenewalStatus String AutoRenewal

The renewal status:

  • AutoRenewal: The CLB instance is automatically renewed.
  • Normal: You must manually renew the CLB instance.
  • NotRenewal: The CLB instance will not be renewed upon expiration. If this value is returned, the system does not send notifications until three days before the expiration date.
    Note This parameter is valid only when you create a subscription CLB instance on the Alibaba Cloud China site. In this case, the PayType parameter must be set to PrePay.
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 CLB instance belongs.

VSwitchId String vsw-255ecrwq5****

The ID of the vSwitch to which the internal-facing CLB 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>2022-09-08T16:00:00Z</EndTime>
  <Address>42.XX.XX.6</Address>
  <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
  <ListenerPortsAndProtocal>
        <ListenerPortAndProtocal>
              <ListenerPort>443</ListenerPort>
              <ListenerProtocal>http</ListenerProtocal>
        </ListenerPortAndProtocal>
  </ListenerPortsAndProtocal>
  <AddressIPVersion>ipv4</AddressIPVersion>
  <LoadBalancerId>lb-bp1b6c719dfa08ex****</LoadBalancerId>
  <ListenerPortsAndProtocol>
        <ListenerPortAndProtocol>
              <ListenerForward>on</ListenerForward>
              <ListenerPort>80</ListenerPort>
              <Description> ListenerDescription</Description>
              <ForwardPort>443</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.s1.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>PayOnDemand</PayType>
  <SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
  <InternetChargeType>paybytraffic</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>1513947075000</AutoReleaseTime>
</DescribeLoadBalancerAttributeResponse>

JSON format

{
    "RenewalDuration": 1,
    "EndTime": "2022-09-08T16:00:00Z",
    "Address": "42.XX.XX.6",
    "ResourceGroupId": "rg-atstuj3rtop****",
    "ListenerPortsAndProtocal": {
        "ListenerPortAndProtocal": {
            "ListenerPort": 443,
            "ListenerProtocal": "http"
        }
    },
    "AddressIPVersion": "ipv4",
    "LoadBalancerId": "lb-bp1b6c719dfa08ex****",
    "ListenerPortsAndProtocol": {
        "ListenerPortAndProtocol": {
            "ListenerForward": "on",
            "ListenerPort": 80,
            "Description": "ListenerDescription"
            "ForwardPort": 443,
            "ListenerProtocol": "https"
        }
    },
    "BackendServers": {
        "BackendServer": {
            "Type": "ecs",
            "Description": <Description>BackendServerDescription</Description>
            "ServerId": "i-djghr2****",
            "Weight": 90
        }
    },
    "ModificationProtectionStatus": "ConsoleProtection",
    "LoadBalancerSpec": "slb.s1.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": "PayOnDemand",
    "SlaveZoneId": "cn-hangzhou-d",
    "InternetChargeType": "paybytraffic",
    "RegionIdAlias": "hangzhou",
    "LoadBalancerName": "lb-instance-test",
    "DeleteProtection": "off",
    "VpcId": "vpc-25dvzy9f8****",
    "EndTimeStamp": 32493801600000,
    "RegionId": "cn-hangzhou",
    "AddressType": "internet",
    "LoadBalancerStatus": "active",
    "CreateTimeStamp": 1504147745000,
    "AutoReleaseTime": 1513947075000
}

Error codes

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