调用DescribeLoadBalancers查询已创建的负载均衡实例。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLoadBalancers

要执行的操作。

取值:DescribeLoadBalancers

RegionId String cn-hangzhou

负载均衡实例的地域ID。

您可以通过调用DescribeRegions接口查询地域ID。

ServerId String vm-server-23****

添加的后端服务器(ECS实例)的ID。

AddressIPVersion String ipv4

IP版本,可以设置为ipv4或者ipv6

LoadBalancerStatus String active

负载均衡实例状态:

  • inactive: 此状态的实例监听不会再转发流量。
  • active: 实例创建后,默认状态为active
  • locked: 实例已经被锁定。
LoadBalancerId String lb-bp1b6c719dfa****

负载均衡实例ID。

支持多值查询,最多可输入10个ID,以半角逗号(,)分隔。

LoadBalancerName String lb-bp1o94dp5i6ea****

负载均衡实例名称。

长度为1~80个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

支持多值查询,最多可输入10个名称,以半角逗号(,)分隔。

ServerIntranetAddress String 10.XX.XX.102

添加的后端服务器(ECS实例)的内网地址。

支持多值查询,以半角逗号(,)分隔。

AddressType String intranet

负载均衡实例的网络类型。

取值:

  • internet:创建公网负载均衡实例后,系统会分配一个公网IP地址,可以转发公网请求。
  • intranet:创建内网负载均衡实例后,系统会分配一个内网IP地址,仅可转发内网请求。
InternetChargeType String 3

公网类型实例付费方式。

取值:paybybandwidthpaybytraffic

  • 3:按带宽计费paybybandwidth。
  • 4:按流量计费paybytraffic(默认值)。
    说明 当PayType参数的值为PrePay时,只支持按带宽计费。
VpcId String vpc-bp1aevy8sof****

负载均衡实例所属的VPC ID。

VSwitchId String vsw-bp12mw1f8k3****

负载均衡实例所属的交换机ID。

NetworkType String vpc

私网负载均衡实例的网络类型,取值:vpcclassic

  • vpc:专有网络实例
  • classic:经典网络实例
Address String 192.XX.XX.6

负载均衡实例的服务地址。

MasterZoneId String cn-hangzhou-b

负载均衡实例的主可用区ID。

SlaveZoneId String cn-hangzhou-d

负载均衡实例的备可用区ID。

目前对金融云用户暂时不支持多可用区功能。

Tags String [{"tagKey":"Key1","tagValue":"Value1"}]

负载均衡实例绑定的标签列表,其结构是一个json dictionary,包含标签键和标签值。

一次请求中,绑定的标签列表中最多支持10个标签。

PayType String PayOnDemand

负载均衡实例付费类型。取值:PayOnDemandPrePay

  • PayOnDemand:按量付费。
  • PrePay:包年包月。
ResourceGroupId String rg-acfmxazb4p****

企业资源组ID。

PageNumber Integer 1

分页查询时的页码。

PageSize Integer 50

分页查询时设置的每页行数。

取值范围:1~100

说明 如果设置了PageSize,则需要同时设置PageNumber

返回数据

名称 类型 示例值 描述
LoadBalancers Array of LoadBalancer

数组格式,返回负载均衡实例列表。

LoadBalancer
LoadBalancerId String lb-bp1b6c719dfa****

负载均衡实例ID。

LoadBalancerName String lb-bp1o94dp5i6ea****

负载均衡实例的名称。

LoadBalancerStatus String active

负载均衡实例状态:

  • inactive: 此状态的实例监听不会再转发流量。
  • active: 实例创建后,默认状态为active
  • locked: 实例已经被锁定。
Address String 100.XX.XX.28

负载均衡实例服务地址。

RegionId String cn-hangzhou

负载均衡实例的地域ID。

RegionIdAlias String hangzhou

负载均衡实例的地域名称。

AddressType String intranet

负载均衡实例的网络类型。

VSwitchId String vsw-255ecr****

私网负载均衡实例的交换机ID。

VpcId String vpc-25dvzy9f8****

私网负载均衡实例的专有网络ID。

NetworkType String vpc

私网负载均衡实例的网络类型,取值:

  • vpc:专有网络实例。
  • classic:经典网络实例。
CreateTime String 2017-08-31T02:49:05Z

负载均衡实例创建时间。

MasterZoneId String cn-hangzhou-b

实例的主可用区ID。

SlaveZoneId String cn-hangzhou-d

实例的备可用区ID。

AddressIPVersion String ipv4

IP版本,可以设置为ipv4或者ipv6

Bandwidth Integer -1

监听的带宽峰值,单位Mbps。取值:

  • -1:对于按流量计费的公网负载均衡实例,可以将带宽峰值设置为-1,即不限制带宽峰值。
  • 1~5120:对于按带宽计费的公网负载均衡实例,可以设置每个监听的带宽峰值,但所有监听的带宽峰值之和不能超过实例的带宽峰值。
CreateTimeStamp Long 1504147745000

负载均衡实例创建时间戳。

DeleteProtection String off

负载均衡删除保护状态。

取值:onoff

InternetChargeType String 3

公网类型实例付费方式。取值:

  • 3:按带宽计费paybybandwidth。
  • 4:按流量计费paybytraffic。
    说明 当PayType参数的值为PrePay时,只支持按带宽计费。
InternetChargeTypeAlias String paybytraffic

公网类型实例付费方式。取值:

  • paybybandwidth:按带宽计费。
  • paybytraffic:按流量计费
    说明 当PayType参数的值为PrePay时,只支持按带宽计费。
LoadBalancerSpec String slb.s1.small

负载均衡实例的性能规格。

ModificationProtectionReason String 托管实例

设置修改保护状态的原因,长度为1~80个字符,必须以字母或中文开头,支持数字、半角句号(.)、下划线(_)和短划线(-)。

说明 仅在ModificationProtectionStatusConsoleProtection时有效。
ModificationProtectionStatus String ConsoleProtection

负载均衡修改保护状态:

  • NonProtection:不限制修改保护,设置后会清空之前设置的ModificationProtectionReason
  • ConsoleProtection:实例控制台修改保护状态。
PayType String PrePay

负载均衡实例付费类型,取值PayOnDemand或者PrePay

ResourceGroupId String rg-atstuj3r****

企业资源组ID。

PageNumber Integer 1

实例列表页码。

PageSize Integer 50

当前分页的行数。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

TotalCount Integer 1

根据过滤条件得到的实例总个数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLoadBalancers
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeLoadBalancersResponse>
  <TotalCount>1</TotalCount>
  <PageSize>50</PageSize>
  <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
  <PageNumber>1</PageNumber>
  <LoadBalancers>
        <LoadBalancer>
              <ResourceGroupId>rg-atstuj3r****</ResourceGroupId>
              <Address>100.XX.XX.28</Address>
              <AddressIPVersion>ipv4</AddressIPVersion>
              <CreateTime>2017-08-31T02:49:05Z</CreateTime>
              <VSwitchId>vsw-255ecr****</VSwitchId>
              <LoadBalancerId>lb-bp1b6c719dfa****</LoadBalancerId>
              <PayType>PrePay</PayType>
              <SlaveZoneId>cn-hangzhou-d</SlaveZoneId>
              <ModificationProtectionStatus>ConsoleProtection</ModificationProtectionStatus>
              <LoadBalancerSpec>slb.s1.small</LoadBalancerSpec>
              <InternetChargeType>3</InternetChargeType>
              <InternetChargeTypeAlias>paybytraffic</InternetChargeTypeAlias>
              <RegionIdAlias>hangzhou</RegionIdAlias>
              <LoadBalancerName>lb-bp1o94dp5i6ea****</LoadBalancerName>
              <DeleteProtection>off</DeleteProtection>
              <VpcId>vpc-25dvzy9f8****</VpcId>
              <NetworkType>vpc</NetworkType>
              <Bandwidth>-1</Bandwidth>
              <ModificationProtectionReason>托管实例</ModificationProtectionReason>
              <RegionId>cn-hangzhou</RegionId>
              <AddressType>intranet</AddressType>
              <LoadBalancerStatus>active</LoadBalancerStatus>
              <CreateTimeStamp>1504147745000</CreateTimeStamp>
              <MasterZoneId>cn-hangzhou-b</MasterZoneId>
        </LoadBalancer>
  </LoadBalancers>
</DescribeLoadBalancersResponse>

JSON格式

{
    "TotalCount": 1,
    "PageSize": 50,
    "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
    "PageNumber": 1,
    "LoadBalancers": {
        "LoadBalancer": {
            "ResourceGroupId": "rg-atstuj3r****",
            "Address": "100.XX.XX.28",
            "AddressIPVersion": "ipv4",
            "CreateTime": "2017-08-31T02:49:05Z",
            "VSwitchId": "vsw-255ecr****",
            "LoadBalancerId": "lb-bp1b6c719dfa****",
            "PayType": "PrePay",
            "SlaveZoneId": "cn-hangzhou-d",
            "ModificationProtectionStatus": "ConsoleProtection",
            "LoadBalancerSpec": "slb.s1.small",
            "InternetChargeType": 3,
            "InternetChargeTypeAlias": "paybytraffic",
            "RegionIdAlias": "hangzhou",
            "LoadBalancerName": "lb-bp1o94dp5i6ea****",
            "DeleteProtection": "off",
            "VpcId": "vpc-25dvzy9f8****",
            "NetworkType": "vpc",
            "Bandwidth": -1,
            "ModificationProtectionReason": "托管实例",
            "RegionId": "cn-hangzhou",
            "AddressType": "intranet",
            "LoadBalancerStatus": "active",
            "CreateTimeStamp": 1504147745000,
            "MasterZoneId": "cn-hangzhou-b"
        }
    }
}

错误码

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