调用DescribeLoadBalancerAttribute查询指定负载均衡实例的详细信息。
接口说明
API 调用频率:100 次/秒。
单用户调用频率:10 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ens:DescribeLoadBalancerAttribute |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| LoadBalancerId |
string |
是 |
负载均衡实例的 ID。 |
lb-5rcvo1n1t3hykfhhjwjgq**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| LoadBalancerId |
string |
负载均衡实例的 ID。 |
lb-5rcvo1n1t3hykfhhjwjgqp**** |
| LoadBalancerName |
string |
负载均衡实例的名称。 |
example |
| LoadBalancerStatus |
string |
负载均衡实例监听状态。取值:
|
Active |
| EnsRegionId |
string |
ENS 节点 ID。 |
cn-chengdu-telecom |
| Address |
string |
负载均衡实例服务地址。 |
192.168.XX.XX |
| NetworkId |
string |
网络 ID。 |
n-5rwbi3g9zvgxcsiufwhw8**** |
| VSwitchId |
string |
交换机 ID。 |
vsw-5s78m2pdr9osa0j64bn78**** |
| Bandwidth |
integer |
负载均衡带宽峰值,默认值为-1(表示不限速)。 |
-1 |
| LoadBalancerSpec |
string |
负载均衡实例的规格。 |
elb.s2.medium |
| CreateTime |
string |
负载均衡实例的创建时间(UTC)。 |
2019-05-21T12:22:00Z |
| EndTime |
string |
负载均衡实例结束时间。 |
2020-05-21T12:22:00Z |
| ListenerPorts |
array |
负载均衡实例前端使用的端口。 |
|
|
string |
负载均衡实例前端使用的端口。 |
80 |
|
| BackendServers |
array<object> |
后端服务器列表。 |
|
|
object |
后端服务器列表。 |
||
| ServerId |
string |
后端服务器实例 ID。 |
i-5vb5h5njxiuhn48a**** |
| Ip |
string |
后端服务器的 IP。 |
192.168.XX.XX |
| Port |
string |
后端服务器使用的端口。 |
0 |
| Type |
string |
后端服务器类型。 |
ens |
| Weight |
integer |
后端服务器的权重。 |
100 |
| ListenerPortsAndProtocols |
array<object> |
负载均衡实例前端使用的端口和协议。 |
|
|
object |
负载均衡实例前端使用的端口和协议。 |
||
| ListenerPort |
integer |
监听端口。 |
8080 |
| ListenerProtocol |
string |
监听协议。 |
tcp |
| Description |
string |
描述信息。 |
test |
| ListenerForward |
string |
是否启用监听转发。 |
off |
| ForwardPort |
integer |
转发到的目的监听端口 |
0 |
| BackendServerPort |
integer |
负载均衡实例后端使用的端口,取值:1~65535。 |
6000 |
| AddressIPVersion |
string |
负载均衡实例的 IP 版本。取值:ipv4 或者 ipv6。 |
ipv4 |
| PayType |
string |
付费类型。取值:
|
PostPaid |
| LoadBalancerType |
string |
||
| AddressType |
string |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"LoadBalancerId": "lb-5rcvo1n1t3hykfhhjwjgqp****",
"LoadBalancerName": "example",
"LoadBalancerStatus": "Active",
"EnsRegionId": "cn-chengdu-telecom",
"Address": "192.168.XX.XX",
"NetworkId": "n-5rwbi3g9zvgxcsiufwhw8****",
"VSwitchId": "vsw-5s78m2pdr9osa0j64bn78****",
"Bandwidth": -1,
"LoadBalancerSpec": "elb.s2.medium",
"CreateTime": "2019-05-21T12:22:00Z",
"EndTime": "2020-05-21T12:22:00Z",
"ListenerPorts": [
"80"
],
"BackendServers": [
{
"ServerId": "i-5vb5h5njxiuhn48a****",
"Ip": "192.168.XX.XX\n",
"Port": "0",
"Type": "ens",
"Weight": 100
}
],
"ListenerPortsAndProtocols": [
{
"ListenerPort": 8080,
"ListenerProtocol": "tcp",
"Description": "test",
"ListenerForward": "off",
"ForwardPort": 0,
"BackendServerPort": 6000
}
],
"AddressIPVersion": "ipv4",
"PayType": "PostPaid",
"LoadBalancerType": "",
"AddressType": ""
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ens.interface.error | Failed to call API. | 接口调用发生异常。 |
| 400 | NoPermission | Permission denied. | |
| 400 | Invalid%s | The specified parameter %s is invalid. | |
| 400 | Missing%s | You must specify the parameter %s. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。