DescribeLoadBalancerAttribute_负载均衡实例_API参考

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLoadBalancerAttribute	要执行的操作。取值：DescribeLoadBalancerAttribute。
LoadBalancerId	String	是	lb-bp1b6c719dfa08ex*****	负载均衡实例ID。
RegionId	String	是	cn-hangzhou	负载均衡实例的地域。您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID。

返回数据


名称	类型	示例值	描述
RequestId	String	365F4154-92F6-4AE4-92F8-7FF34B540710	请求ID。
LoadBalancerId	String	lb-dhhd******	负载均衡实例的ID。
ResourceGroupId	String	rg-atstuj3rtop*****	企业资源组ID。
LoadBalancerName	String	abc	负载均衡实例的名称。
LoadBalancerStatus	String	active	负载均衡实例状态： inactive：实例已停止，此状态的实例监听不会再转发流量。 active：实例运行中，实例创建后，默认状态为active。 locked：实例已锁定，实例已经欠费或被阿里云锁定。
RegionId	String	cn-hangzhou	负载均衡实例所在地域ID。
RegionIdAlias	String	cn-hangzhou	负载均衡实例所属的地域别名。
Address	String	42.250.6.**	负载均衡实例的服务地址。
AddressType	String	internet	负载均衡实例的地址类型。
VpcId	String	vpc-25dvzy9f8*****	私网负载均衡实例的专有网络ID。
VSwitchId	String	vsw-255ecrwq5*****	私网负载均衡实例的交换机ID。
NetworkType	String	vpc	负载均衡实例的网络类型。
InternetChargeType	String	paybybandwidth	公网类型实例付费方式。取值：paybybandwidth\|paybytraffic。 paybybandwidth：按带宽计费。 paybytraffic：按流量计费（默认值）。
AutoReleaseTime	Long	1513947075	预约释放时间。
Bandwidth	Integer	5	按带宽计费的公网型实例的带宽峰值。
LoadBalancerSpec	String	slb.s2.small	负载均衡实例的的性能规格。
CreateTime	String	2017-08-31T02:49:05Z	负载均衡实例的创建时间。
CreateTimeStamp	Long	1504147745000	负载均衡实例创建时间戳。
EndTime	String	2999-09-08T16:00:00Z	负载均衡实例结束时间。
EndTimeStamp	Long	32493801600000	负载均衡实例结束时间戳。
PayType	String	PrePay	负载均衡实例付费类型，取值PayOnDemand或者PrePay。
MasterZoneId	String	cn-hangzhou-b	负载均衡实例的主可用区ID。
SlaveZoneId	String	cn-hangzhou-d	负载均衡实例的备可用区ID。
AddressIPVersion	String	ipv4	IP版本。
RenewalDuration	Integer	1	自动续费时长，仅在RenewalStatus为AutoRenewal时有效. PeriodUnit为Year时，取值：1，2，3。 PeriodUnit为Month时，取值：1，2，3，6。
RenewalStatus	String	AutoRenewal	续费状态，取值： AutoRenewal：自动续费。 Normal：非自动续费，您需要自行续费负载均衡实例。 NotRenewal：不再续费。返回该值后，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。
RenewalCycUnit	String	Month	自动续费周期，仅在RenewalStatus为AutoRenewal时有效。取值：Year \| Month（默认值）。
DeleteProtection	String	off	是否开启实例删除保护。取值：on\|off。
ListenerPortsAndProtocal	Array		同ListenerPortsAndProtocol。
ListenerPort	Integer	443	负载均衡实例前端使用的端口。
ListenerProtocal	String	http	负载均衡实例前端使用的协议。
ListenerPortsAndProtocol	Array		负载均衡实例前端使用的端口和协议列表。
ListenerPort	Integer	443	负载均衡实例前端使用的端口。
ListenerProtocol	String	https	负载均衡实例前端使用的协议。
ListenerForward	String	yes	是否启用监听转发。
ForwardPort	Integer	80	转发到的目的监听端口，必须是已经存在的HTTPS监听端口。
Description	String	监听描述。	负载均衡监听端口和协议描述。
BackendServers	Array		负载均衡实例的后端服务器列表。
ServerId	String	i-djghr2****	后端服务器实例ID。
Weight	Integer	90	后端服务器的权重。
Type	String	ecs	后端服务器类型。
Description	String	后端服务器描述。	后端服务器描述。
ListenerPorts	List	80	负载均衡实例前端使用的端口列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLoadBalancerAttribute
&LoadBalancerId=lb-bp1b6c719dfa08ex*****
&<公共请求参数>

正常返回示例

XML 格式

<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></ListenerPorts>
	  <InternetChargeType>paybytraffic</InternetChargeType>
	  <VSwitchId>vsw-bp12mw1f8k3*********</VSwitchId>
	  <VpcId>vpc-bp1aevy8sofi8mh*****</VpcId>
	  <SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
	  <LoadBalancerSpec>slb.s2.small</LoadBalancerSpec>
	  <NetworkType>vpc</NetworkType>
	  <ListenerPortsAndProtocol></ListenerPortsAndProtocol>
	  <PayType>PayOnDemand</PayType>
	  <Bandwidth>5120</Bandwidth>
	  <LoadBalancerName>abc1</LoadBalancerName>
	  <ResourceGroupId>rg-acfmxazb4p*****</ResourceGroupId>
	  <AddressIPVersion>ipv4</AddressIPVersion>
	  <LoadBalancerId>lb-bp1b6c719dfa08e*****</LoadBalancerId>
	  <EndTimeStamp>32493801600000</EndTimeStamp>
	  <MasterZoneId>cn-hangzhou-b</MasterZoneId>
	  <ListenerPortsAndProtocal></ListenerPortsAndProtocal>
	  <Address>192.168.0.*</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 格式

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

错误码

访问错误中心查看更多错误码。