DescribeLoadBalancerAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the detail of a Classic Load Balancer (CLB) instance.

Operation description

Note If backend servers are deployed in a vServer group, you can call the DescribeVServerGroupAttribute operation to query the backend servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
slb:DescribeLoadBalancerAttribute	get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the CLB instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
LoadBalancerId	string	Yes	The CLB instance ID.	lb-bp1b6c719dfa08ex****

Response parameters

Parameter	Type	Description	Example
	object
VpcId	string	The ID of the virtual private cloud (VPC) where the internal-facing CLB instance is deployed.	vpc-25dvzy9f8****
Tags	array<object>	The tags.
	object
TagKey	string	The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be at most 64 characters in length, and cannot contain `http://` or `https://`. It must not start with `aliyun` or `acs:`.	test
TagValue	string	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.	value
CreateTimeStamp	long	The timestamp generated when the CA certificate is uploaded.	1504147745000
CreateTime	string	The time when the CLB instance was created. The time is in the `YYYY-MM-DDThh:mm:ssZ` format.	2017-08-31T02:49:05Z
LoadBalancerId	string	The CLB instance ID.	lb-bp1b6c719dfa08ex****
PayType	string	The billing method of the CLB instance. Valid values: Only PayOnDemand may be returned, which indicates the pay-as-you-go billing method.	PayOnDemand
AddressType	string	The address type of the CLB instance.	internet
NetworkType	string	The network type of the CLB instance.	vpc
AddressIPVersion	string	The version of the IP address. Valid values: ipv4 and ipv6.	ipv4
RenewalCycUnit	string	The auto-renewal cycle. Valid values: Year and Month. Default value: Month. Note This parameter is valid only if you create a subscription CLB instance on the Alibaba Cloud China site. In this case, PayType must be set to PrePay and RenewalStatus must be set to AutoRenewal.	Month
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
Bandwidth	integer	The maximum bandwidth of the Internet-facing CLB instance that is billed on a pay-by-bandwidth basis.	5
LoadBalancerName	string	The name of the CLB instance.	lb-instance-test
Address	string	The service IP address of the CLB instance.	42.XX.XX.6
SlaveZoneId	string	The ID of the secondary zone to which the CLB instance belongs.	cn-hangzhou-d
EndTimeStamp	long	The timestamp that indicates the expiration time of the CLB instance.	32493801600000
MasterZoneId	string	The ID of the primary zone to which the CLB instance belongs.	cn-hangzhou-b
LoadBalancerSpec	string	The specification of the CLB instance.	slb.s1.small
AutoReleaseTime	long	The timestamp generated when the CLB instance is released.	1513947075000
ModificationProtectionReason	string	The reason why the configuration read-only mode is enabled. The value is 1 to 80 characters in length. It starts with a letter and can contain digits, periods (.), underscores (_), and hyphens (-). Note This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection.	Managed instance
RegionId	string	The region ID of the CLB instance.	cn-hangzhou
ModificationProtectionStatus	string	Indicates whether the configuration read-only mode is enabled. Valid values: NonProtection: The configuration read-only mode is disabled. After you disable the configuration read-only mode, the value of ModificationProtectionReason is cleared. ConsoleProtection: The configuration read-only mode is enabled. Note If this parameter is set to ConsoleProtection, you cannot modify instance configurations in the CLB console. However, you can modify instance configurations by calling API operations.	ConsoleProtection
EndTime	string	The time when the CLB instance expires.	2022-09-08T16:00:00Z
VSwitchId	string	The ID of the vSwitch to which the internal-facing CLB instance belongs.	vsw-255ecrwq5****
LoadBalancerStatus	string	The status of the CLB instance. Valid values: inactive: The CLB instance is disabled. 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 due to overdue payments or other reasons.	active
ResourceGroupId	string	The resource group ID.	rg-atstuj3rtop****
InternetChargeType	string	The metering method of the Internet-facing CLB instance. Valid values: paybytraffic paybybandwidth	paybytraffic
DeleteProtection	string	Indicates whether deletion protection is enabled for the CLB instance. Valid values: on and off.	off
RegionIdAlias	string	The alias of the region to which the CLB instance belongs.	hangzhou
RenewalStatus	string	Indicates whether auto-renewal is enabled. Valid values: AutoRenewal: Auto-renewal is enabled. Normal: Auto-renewal is disabled. 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, PayType must be set to PrePay**.	AutoRenewal
RenewalDuration	integer	The auto-renewal duration. This parameter is valid only if RenewalStatus is set to AutoRenewal. Valid values when PeriodUnit is set to Year: 1, 2, and 3. Valid values when PeriodUnit 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.	1
ListenerPorts	array	The frontend port used by the CLB instance.
	integer	The frontend port used by the CLB instance.	80
ListenerPortsAndProtocal	array<object>	The ports or protocols of the listeners.
	object
ListenerProtocal	string	The frontend protocol that is used by the CLB instance.	http
ListenerPort	integer	The frontend port that is used by the CLB instance.	443
ListenerPortsAndProtocol	array<object>	The ports or protocols of the listeners.
	object
ListenerPort	integer	The frontend port that is used by the CLB instance.	80
ListenerProtocol	string	The frontend protocol that is used by the CLB instance.	https
ListenerForward	string	Indicates whether the listener is enabled.	on
Description	string	Indicates whether the listener is enabled.	Listener Description
ForwardPort	integer	The destination listening port to which requests are forwarded. The port must be open and use HTTPS.	443
BackendServers	array<object>	The backend servers of the CLB instance.
	object
Type	string	The type of the backend server.	ecs
Weight	integer	The weight of the backend server.	90
Description	string	The description of the backend server. Note This parameter is not returned if Description is not set.	backend server description
ServerIp	string	The ID of the elastic network interface (ENI) or elastic container instance.	192.XX.XX.11
ServerId	string	The backend server ID.	i-2zej4lxhjoq1icu*****
InstanceChargeType	string	The metering method of the CLB instance. Valid values: PayBySpec (default) PayByCLCU Note This parameter is available only on the China site and takes effect only when PayType is set to PayOnDemand.	PayBySpec

Examples

Sample success responses

JSONformat

{
  "VpcId": "vpc-25dvzy9f8****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "value"
      }
    ]
  },
  "CreateTimeStamp": 1504147745000,
  "CreateTime": "2017-08-31T02:49:05Z",
  "LoadBalancerId": "lb-bp1b6c719dfa08ex****",
  "PayType": "PayOnDemand",
  "AddressType": "internet",
  "NetworkType": "vpc",
  "AddressIPVersion": "ipv4",
  "RenewalCycUnit": "Month",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Bandwidth": 5,
  "LoadBalancerName": "lb-instance-test",
  "Address": "42.XX.XX.6",
  "SlaveZoneId": "cn-hangzhou-d",
  "EndTimeStamp": 32493801600000,
  "MasterZoneId": "cn-hangzhou-b",
  "LoadBalancerSpec": "slb.s1.small",
  "AutoReleaseTime": 1513947075000,
  "ModificationProtectionReason": "Managed instance",
  "RegionId": "cn-hangzhou",
  "ModificationProtectionStatus": "ConsoleProtection",
  "EndTime": "2022-09-08T16:00:00Z",
  "VSwitchId": "vsw-255ecrwq5****",
  "LoadBalancerStatus": "active",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "InternetChargeType": "paybytraffic",
  "DeleteProtection": "off",
  "RegionIdAlias": "hangzhou",
  "RenewalStatus": "AutoRenewal",
  "RenewalDuration": 1,
  "ListenerPorts": {
    "ListenerPort": [
      80
    ]
  },
  "ListenerPortsAndProtocal": {
    "ListenerPortAndProtocal": [
      {
        "ListenerProtocal": "http",
        "ListenerPort": 443
      }
    ]
  },
  "ListenerPortsAndProtocol": {
    "ListenerPortAndProtocol": [
      {
        "ListenerPort": 80,
        "ListenerProtocol": "https",
        "ListenerForward": "on",
        "Description": "Listener Description",
        "ForwardPort": 443
      }
    ]
  },
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 90,
        "Description": "backend server description",
        "ServerIp": "192.XX.XX.11",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  },
  "InstanceChargeType": "PayBySpec"
}

Error codes

HTTP status code	Error code	Error message
400	LocationServiceTimeout	Location service connection timeout. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-08	The Error code has changed	View Change Details