You can call the DescribeLoadBalancerAttribute API to query the details of an SLB instance.

Debug

Click here to perform a debug operation in OpenAPI Explorer and automatically generate an SDK code example.

Request parameters

Name Type Required? Example value Description
Action String Yes DescribeLoadBalancerAttribute

The action to perform. Valid value: DescribeLoadBalancerAttribute

LoadBalancerId String Yes lb-bp1b6c719dfa08exfuca5

The ID of the SLB instance

RegionId String Yes cn-hangzhou

The region to which the SLB instance belongs.

You can query the region ID by referring to the list of regions and zones or by calling the DescribeRegions API.

Response parameters

Name Type Example value Description
LoadBalancerId String 139a00604ad-cn-east-hangzhou-01

The ID of the SLB instance

RegionId String cn-hangzhou

The ID of the region to which the SLB instance belongs

RegionIdAlias String cn-hangzhou

The alias of the region to which the SLB instance belongs

LoadBalancerName String abc

The name of the SLB instance

LoadBalancerStatus String active

The status of the SLB instance.

  • inactive: When the SLB instance is inactive, the listeners of the instance do not distribute traffic.
  • active: After an instance is created, it is in active status by default.
  • Locked: The payment of the instance is overdue or the instance is locked by Alibaba Cloud.
Address String 42.250.6.36

The IP address of the SLB instance

AddressType String internet

The address type of the SLB instance

NetworkType String vpc

The network type of the SLB instance

VpcId String vpc-25dvzy9f8

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

Bandwidth Integer 5

The peak bandwidth of an Internet instance that is billed by bandwidth

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

The time when the SLB instance is created

ListenerPorts "ListenerPort": [ 80, 443 ]

The list of frontend ports used by the SLB instance

ListenerPortsAndProtocol

The list of frontend ports and protocols used by the SLB instance

  └ListenerPort Integer 443

The frontend port used by the SLB instance

  └ListenerProtocol String https

The frontend protocol used by the SLB instance

  └Description String Listener

A description of the SLB instance listening ports and protocols

  └ForwardPort Integer 80

The destination listening port. It must be an existing HTTPS listening port.

  └ListenerForward String yes

Whether to enable listener forwarding

BackendServers

The list of backend servers added to the SLB instance

  └ServerId String vm-234

The ID of the backend server (ECS instance)

  └Weight Integer 90

The weight of the ECS instance

  └Description String Description

A description of the backend server

  └Type String ecs

The type of backend server

MasterZoneId String cn-hangzhou-b

The primary zone ID of the SLB instance

AddressIPVersion String ipv4

The IP version

AutoReleaseTime Long 1513947075

The specified release time

CreateTimeStamp Long 1504147745000

The timestamp indicating when the SLB instance is created

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

The end time of the SLB instance

EndTimeStamp Long 32493801600000

The timestamp indicating when the SLB instance ends

InternetChargeType String paybybandwidth

The billing method of an Internet SLB instance. Valid values: paybybandwidth | paybytraffic.

ListenerPortsAndProtocal

The same as ListenerPortsAndProtocol.

  └ListenerPort Integer 443

The frontend port used by the SLB instance

  └ListenerProtocal String http

The frontend protocol used by the SLB instance

LoadBalancerSpec String slb.s2.small

The specification of the SLB instance

PayType String PrePay

The billing method of the SLB instance. Valid values: PayOnDemand or PrePay.

RenewalCycUnit String Month

Automatic renewal cycle. It applies only when the value of RenewalStatus is AutoRenewal.

Valid values: Year | Month (default value)

RenewalDuration Integer 1

Automatic renewal period of validity. It applies only when the value of RenewalStatus is AutoRenewal.

  • Valid values are 1, 2, and 3 when the value of PeriodUnit is Year.
  • Valid values are 1, 2, 3, and 6 when the value of PeriodUnit is Month.
RenewalStatus String AutoRenewal

Renewal mode. Valid values:

  • AutoRenewal: Automatic renewal is enabled.
  • Normal: You can only renew your usage of the SLB instance manually.
  • NotRenewal: Stop renewal for the instance. If this value is returned, Alibaba Cloud stops sending notifications about the impending instance expiration, and only send one reminder on the third day before the instance expires.
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request

ResourceGroupId String rg-atstuj3rtoptyui

The ID of the enterprise resource group

SlaveZoneId String cn-hangzhou-d

The backup zone ID of the SLB instance

VSwitchId String vsw-255ecrwq5

The ID of the VSwitch to which the intranet SLB instance belongs

Examples

Request example


http(s)://[Endpoint]/? Action=DescribeLoadBalancerAttribute
&LoadBalancerId=lb-bp1b6c719dfa08exfuca5
&<CommonParameters>

Normal response examples

XML format

<DescribeLoadBalancerAttributeResponse>
  <CreateTimeStamp>1541679713000</CreateTimeStamp>
  <RegionIdAlias>cn-hangzhou</RegionIdAlias>
  <BackendServers>
    <BackendServer>
      <ServerId>i-bp1c3zrr37ablp8ujo7v</ServerId>
      <Weight>100</Weight>
      <Type>ecs</Type>
    </BackendServer>
  </BackendServers>
  <HasReservedInfo>false</HasReservedInfo>
  <ListenerPorts/>
  <InternetChargeType>paybytraffic</InternetChargeType>
  <VSwitchId>vsw-bp12mw1f8k3jgygk9bmlj</VSwitchId>
  <VpcId>vpc-bp1aevy8sofi8mh1qc5cm</VpcId>
  <SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
  <LoadBalancerSpec>slb.s2.small</LoadBalancerSpec>
  <NetworkType>vpc</NetworkType>
  <ListenerPortsAndProtocol/>
  <PayType>PayOnDemand</PayType>
  <Bandwidth>5120</Bandwidth>
  <LoadBalancerName>abc1</LoadBalancerName>
  <ResourceGroupId>rg-acfmxazb4ph6aiy</ResourceGroupId>
  <AddressIPVersion>ipv4</AddressIPVersion>
  <LoadBalancerId>lb-bp1b6c719dfa08exfuca5</LoadBalancerId>
  <EndTimeStamp>32493801600000</EndTimeStamp>
  <MasterZoneId>cn-hangzhou-b</MasterZoneId>
  <ListenerPortsAndProtocal/>
  <Address>192.168.0.6</Address>
  <RegionId>cn-hangzhou</RegionId>
  <RequestId>35D745B3-1567-4855-9EF1-F5CED3C1670C</RequestId>
  <CreateTime>2018-11-08T12:21:53Z</CreateTime>
  <AddressType>intranet</AddressType>
  <EndTime>2999-09-08T16:00:00Z</EndTime>
  <LoadBalancerStatus>active</LoadBalancerStatus>
</DescribeLoadBalancerAttributeResponse>

JSON format

{
	"CreateTimeStamp":1541679713000,
	"RegionIdAlias":"cn-hangzhou",
	"HasReservedInfo":"false",
	"BackendServers":{
		"BackendServer":[
			{
				"ServerId":"i-bp1c3zrr37ablp8ujo7v",
				"Weight":100,
				"Type":"ecs"
			}
		]
	},
	"ListenerPorts":{
		"ListenerPort":[]
	},
	"VSwitchId":"vsw-bp12mw1f8k3jgygk9bmlj",
	"InternetChargeType":"paybytraffic",
	"VpcId":"vpc-bp1aevy8sofi8mh1qc5cm",
	"SlaveZoneId":"cn-hangzhou-d",
	"NetworkType":"vpc",
	"LoadBalancerSpec":"slb.s2.small",
	"ListenerPortsAndProtocol":{
		"ListenerPortAndProtocol":[]
	},
	"PayType":"PayOnDemand",
	"Bandwidth":5120,
	"LoadBalancerName":"abc1",
	"ResourceGroupId":"rg-acfmxazb4ph6aiy",
	"AddressIPVersion":"ipv4",
	"LoadBalancerId":"lb-bp1b6c719dfa08exfuca5",
	"EndTimeStamp":32493801600000,
	"MasterZoneId":"cn-hangzhou-b",
	"ListenerPortsAndProtocal":{
		"ListenerPortAndProtocal":[]
	},
	"Address":"192.168.0.6",
	"RegionId":"cn-hangzhou",
	"RequestId":"35D745B3-1567-4855-9EF1-F5CED3C1670C",
	"CreateTime":"2018-11-08T12:21:53Z",
	"EndTime":"2999-09-08T16:00:00Z",
	"AddressType":"intranet",
	"LoadBalancerStatus":"active"
}

Error codes

Click here to view the error codes.