文档

DescribeLoadBalancerAttribute - 查询指定负载均衡实例信息

更新时间:

调用DescribeLoadBalancerAttribute查询指定负载均衡实例的详细信息。

接口说明

  • API 调用频率:100 次/秒。
  • 单用户调用频率:10 次/秒。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeLoadBalancerAttributeget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
LoadBalancerIdstring

负载均衡实例的 ID。

lb-5rcvo1n1t3hykfhhjwjgq****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
LoadBalancerIdstring

负载均衡实例的 ID。

lb-5rcvo1n1t3hykfhhjwjgqp****
LoadBalancerNamestring

负载均衡实例的名称。

example
LoadBalancerStatusstring

负载均衡实例监听状态。取值:

  • Active:实例中的监听可以根据规则转发接收的流量。
  • InActive:实例中的监听不会再转发接收的流量。
Active
EnsRegionIdstring

ENS 节点 ID。

cn-chengdu-telecom
Addressstring

负载均衡实例服务地址。

192.168.XX.XX
NetworkIdstring

网络 ID。

n-5rwbi3g9zvgxcsiufwhw8****
VSwitchIdstring

交换机 ID。

vsw-5s78m2pdr9osa0j64bn78****
Bandwidthinteger

负载均衡带宽峰值,默认值为-1(表示不限速)。

-1
LoadBalancerSpecstring

负载均衡实例的规格。

elb.s2.medium
CreateTimestring

负载均衡实例的创建时间(UTC)。

2019-05-21T12:22:00Z
EndTimestring

负载均衡实例结束时间。

2020-05-21T12:22:00Z
ListenerPortsarray

负载均衡实例前端使用的端口。

string

负载均衡实例前端使用的端口。

80
BackendServersarray<object>

后端服务器列表。

object

后端服务器列表。

ServerIdstring

后端服务器实例 ID。

i-5vb5h5njxiuhn48a****
Ipstring

后端服务器的 IP。

192.168.XX.XX
Portstring

后端服务器使用的端口。

0
Typestring

后端服务器类型。

ens
Weightinteger

后端服务器的权重。

100
ListenerPortsAndProtocolsarray<object>

负载均衡实例前端使用的端口和协议。

object

负载均衡实例前端使用的端口和协议。

ListenerPortinteger

监听端口。

8080
ListenerProtocolstring

监听协议。

tcp
Descriptionstring

描述信息。

test
ListenerForwardstring

是否启用监听转发。

off
ForwardPortinteger

转发到的目的监听端口

0
AddressIPVersionstring

负载均衡实例的 IP 版本。取值:ipv4 或者 ipv6。

ipv4
PayTypestring

付费类型。取值:

  • PrePaid:预付费。
  • PostPaid(目前仅支持该付费类型):后付费。
PostPaid

示例

正常返回示例

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
    }
  ],
  "AddressIPVersion": "ipv4",
  "PayType": "PostPaid"
}

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorAn error occurred while call the API.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更查看变更详情