DescribeLoadBalancers - 查询已创建的负载均衡实例 - 负载均衡

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
slb:DescribeLoadBalancers	get	LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	传统型负载均衡实例的地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou
ServerId	string	否	添加的后端服务器 ID。	i-2zebcbq******
AddressIPVersion	string	否	IP 版本，可以设置为 ipv4 或者 ipv6。	ipv4
LoadBalancerStatus	string	否	实例状态。取值： inactive: 实例已停止，此状态的实例监听不会再转发流量。 active: 实例运行中，实例创建后，默认状态为 active。 locked: 实例已锁定。当负载均衡实例到期后，但到期时间未超过 7 天时，负载均衡实例进入锁定状态。此种状态下，您不能对负载均衡实例进行任何操作，并且实例不再会进行流量转发，但会保留实例的 IP 和其它配置。	active
LoadBalancerId	string	否	传统型负载均衡实例 ID。支持多值查询，最多可输入 10 个 ID，以半角逗号（,）分隔。	lb-bp1b6c719dfa****
LoadBalancerName	string	否	传统型负载均衡实例名称。长度为 1~80 个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。支持多值查询，最多可输入 10 个名称，以半角逗号（,）分隔。	test
ServerIntranetAddress	string	否	添加的后端服务器的内网地址。支持多值查询，以半角逗号（,）分隔。	10.XX.XX.102
AddressType	string	否	传统型负载均衡实例的网络类型。取值： internet：创建公网负载均衡实例后，系统会分配一个公网 IP 地址，可以转发公网请求。 intranet：创建内网负载均衡实例后，系统会分配一个内网 IP 地址，仅可转发内网请求。	intranet
InternetChargeType	string	否	公网计费方式。取值： paybybandwidth：按带宽计费。 paybytraffic：按流量计费。	paybytraffic
VpcId	string	否	传统型负载均衡实例所属的 VPC ID。	vpc-bp1aevy8sof****
VSwitchId	string	否	传统型负载均衡实例所属的交换机 ID。	vsw-bp12mw1f8k3****
NetworkType	string	否	私网实例的网络类型。取值： vpc：专有网络实例。 classic：经典网络实例。	vpc
Address	string	否	传统型负载均衡实例的服务地址。	192.168.XX.XX
MasterZoneId	string	否	负载均衡实例的主可用区 ID。	cn-hangzhou-b
SlaveZoneId	string	否	传统型负载均衡实例的备可用区 ID。目前对金融云用户暂时不支持多可用区功能。	cn-hangzhou-d
Tags	string	否	传统型负载均衡实例绑定的标签列表，其结构是一个 JSON dictionary，包含标签键和标签值。一次请求中，绑定的标签列表中最多支持 10 个标签。	[{"tagKey":"Key1","tagValue":"Value1"}]
PayType	string	否	传统型负载均衡实例付费模式。取值： PayOnDemand：按量付费。	PayOnDemand
ResourceGroupId	string	否	企业资源组 ID。	rg-acfmxazb4p****
PageNumber	integer	否	分页查询时的页码。	1
PageSize	integer	否	分页查询时设置的每页行数。取值范围：1~100。说明如果设置了 PageSize，则需要同时设置 PageNumber。	50
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	资源的标签键。N 的取值范围：1~20。一旦输入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。N 的取值范围：1~20。一旦输入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
PageNumber	integer	实例列表页码。	1
PageSize	integer	当前分页的行数。	50
TotalCount	integer	根据过滤条件得到的实例总个数。	1
LoadBalancers	array<object>	数组格式，返回负载均衡实例列表。
	object
VpcId	string	私网负载均衡实例的专有网络 ID。	vpc-25dvzy9f8****
CreateTimeStamp	long	实例创建时间戳。	1504147745000
LoadBalancerId	string	负载均衡实例 ID。	lb-bp1b6c719dfa****
CreateTime	string	实例创建时间，格式为：`YYYY-MM-DDThh:mm:ssZ`。	2021-12-02T02:49:05Z
PayType	string	负载均衡实例付费模式，取值： PayOnDemand：按量付费。	PayOnDemand
AddressType	string	实例的网络类型。取值： internet：创建公网负载均衡实例后，系统会分配一个公网 IP 地址，可以转发公网请求。 intranet：创建内网负载均衡实例后，系统会分配一个内网 IP 地址，仅可转发内网请求。	intranet
NetworkType	string	私网负载均衡实例的网络类型，取值： vpc：专有网络实例。 classic：经典网络实例。	vpc
AddressIPVersion	string	IP 版本，可以设置为 ipv4 或者 ipv6。	ipv4
LoadBalancerName	string	负载均衡实例的名称。	lb-bp1o94dp5i6ea****
Bandwidth	integer	监听的带宽峰值，单位：Mbps。	-1
Address	string	负载均衡实例服务地址。	100.XX.XX.28
SlaveZoneId	string	实例的备可用区 ID。	cn-hangzhou-d
MasterZoneId	string	实例的主可用区 ID。	cn-hangzhou-b
InternetChargeTypeAlias	string	公网计费方式。取值： paybybandwidth：按带宽计费。 paybytraffic：按流量计费	paybybandwidth
LoadBalancerSpec	string	负载均衡实例的性能规格。说明按流量计费的实例无性能规格属性，默认返回 slb.lcu.elastic。	slb.s1.small
RegionId	string	负载均衡实例的地域 ID。	cn-hangzhou
ModificationProtectionReason	string	设置修改保护状态的原因，长度为 1~80 个字符，必须以字母或中文开头，支持数字、半角句号（.）、下划线（_）和短划线（-）。说明仅在`ModificationProtectionStatus`为 ConsoleProtection 时有效。	托管实例
ModificationProtectionStatus	string	负载均衡修改保护状态： NonProtection：不限制修改保护，设置后会清空之前设置的`ModificationProtectionReason`。 ConsoleProtection：实例控制台修改保护状态。说明当取值为 ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用 API 修改实例配置。	ConsoleProtection
VSwitchId	string	私网负载均衡实例的交换机 ID。	vsw-255ecr****
LoadBalancerStatus	string	负载均衡实例状态。取值： inactive：实例已停止，此状态的实例监听不会再转发流量。 active：实例运行中，实例创建后，默认状态为 active。 locked：实例已锁定，实例已经被锁定。	active
ResourceGroupId	string	企业资源组 ID。	rg-atstuj3r****
InternetChargeType	string	公网类型实例付费方式。取值： 3：按带宽计费（paybybandwidth）。 4：按流量计费（paybytraffic）。	3
DeleteProtection	string	负载均衡删除保护状态。取值： on：开启。 off：关闭。	off
RegionIdAlias	string	传统型负载均衡实例的地域名称。	cn-hangzhou
Tags	array<object>	标签列表
	object
TagValue	string	标签值。	testvalue
TagKey	string	标签键。	testkey
InstanceChargeType	string	实例计费方式，取值： PayBySpec：按规格计费。 PayByCLCU：按使用量计费。说明该参数仅适用于中国站且当 PayType（实例付费模式）取值为 PayOnDemand（按量付费）时，该参数生效。	PayBySpec

示例

正常返回示例

JSON格式

{
  "RequestId": "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "VpcId": "vpc-25dvzy9f8****",
        "CreateTimeStamp": 1504147745000,
        "LoadBalancerId": "lb-bp1b6c719dfa****",
        "CreateTime": "2021-12-02T02:49:05Z",
        "PayType": "PayOnDemand",
        "AddressType": "intranet",
        "NetworkType": "vpc",
        "AddressIPVersion": "ipv4",
        "LoadBalancerName": "lb-bp1o94dp5i6ea****",
        "Bandwidth": -1,
        "Address": "100.XX.XX.28",
        "SlaveZoneId": "cn-hangzhou-d",
        "MasterZoneId": "cn-hangzhou-b",
        "InternetChargeTypeAlias": "paybybandwidth",
        "LoadBalancerSpec": "slb.s1.small",
        "RegionId": "cn-hangzhou",
        "ModificationProtectionReason": "托管实例",
        "ModificationProtectionStatus": "ConsoleProtection",
        "VSwitchId": "vsw-255ecr****",
        "LoadBalancerStatus": "active",
        "ResourceGroupId": "rg-atstuj3r****",
        "InternetChargeType": "3",
        "DeleteProtection": "off",
        "RegionIdAlias": "cn-hangzhou",
        "Tags": {
          "Tag": [
            {
              "TagValue": "testvalue",
              "TagKey": "testkey"
            }
          ]
        },
        "InstanceChargeType": "PayBySpec"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidTag	The specified tags is invalid.	指定的TagKey无效。请检查参数约束，并在修改后重试。
400	TooManyResult	fuzzy query retrieve too many instances.	检索到的实例数量过多，请提供更具体的查询条件。
400	LocationServiceTimeout	Location service connection timeout. Please try again later.	Location服务连接超时，请稍后重试。

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

变更历史

变更时间	变更内容概要	操作
2023-09-08	OpenAPI 错误码发生变更	查看变更详情
2023-07-04	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情