文档

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

更新时间:

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

调试

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

调试

授权信息

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

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

请求参数

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

传统型负载均衡实例的地域ID。

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

cn-hangzhou
ServerIdstring

添加的后端服务器ID。

vm-server-23****
AddressIPVersionstring

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

ipv4
LoadBalancerStatusstring

实例状态。取值:

  • inactive: 实例已停止,此状态的实例监听不会再转发流量。

  • active: 实例运行中,实例创建后,默认状态为active

  • locked: 实例已锁定。当负载均衡实例到期后,但到期时间未超过7天时,负载均衡实例进入锁定状态。此种状态下,您不能对负载均衡实例进行任何操作,并且实例不再会进行流量转发,但会保留实例的IP和其它配置。

active
LoadBalancerIdstring

传统型负载均衡实例ID。

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

lb-bp1b6c719dfa****
LoadBalancerNamestring

传统型负载均衡实例名称。

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

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

test
ServerIntranetAddressstring

添加的后端服务器的内网地址。

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

10.XX.XX.102
AddressTypestring

传统型负载均衡实例的网络类型。取值:

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

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

intranet
InternetChargeTypestring

公网计费方式。取值:

  • paybybandwidth:按带宽计费。

  • paybytraffic:按流量计费。

PayType参数的值为PrePay时,只支持按带宽计费。当InstanceChargeType参数的值为PayByCLCU时,只支持按流量计费。

paybytraffic
VpcIdstring

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

vpc-bp1aevy8sof****
VSwitchIdstring

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

vsw-bp12mw1f8k3****
NetworkTypestring

私网实例的网络类型。取值:

  • vpc:专有网络实例。

  • classic:经典网络实例。

vpc
Addressstring

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

192.168.XX.XX
MasterZoneIdstring

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

cn-hangzhou-b
SlaveZoneIdstring

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

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

cn-hangzhou-d
Tagsstring

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

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

[{"tagKey":"Key1","tagValue":"Value1"}]
PayTypestring

传统型负载均衡实例付费模式。取值:

  • PayOnDemand:按量付费。
  • PrePay:包年包月。
PayOnDemand
ResourceGroupIdstring

企业资源组ID。

rg-acfmxazb4p****
PageNumberinteger

分页查询时的页码。

1
PageSizeinteger

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

取值范围:1~100

说明 如果设置了PageSize,则需要同时设置PageNumber
50
Tagobject []

标签列表。

Keystring

资源的标签键。N的取值范围:1~20。一旦输入该值,则不允许为空字符串。

最多支持64个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。N的取值范围:1~20。一旦输入该值,可以为空字符串。 最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
PageNumberinteger

实例列表页码。

1
PageSizeinteger

当前分页的行数。

50
TotalCountinteger

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

1
LoadBalancersobject []

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

VpcIdstring

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

vpc-25dvzy9f8****
CreateTimeStamplong

实例创建时间戳。

1504147745000
LoadBalancerIdstring

负载均衡实例ID。

lb-bp1b6c719dfa****
CreateTimestring

实例创建时间,格式为:YYYY-MM-DDThh:mm:ssZ

2021-12-02T02:49:05Z
PayTypestring

负载均衡实例付费模式,取值:

  • PayOnDemand:按量付费。
  • PrePay:包年包月。
PayOnDemand
AddressTypestring

实例的网络类型。取值:

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

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

intranet
NetworkTypestring

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

  • vpc:专有网络实例。

  • classic:经典网络实例。

vpc
AddressIPVersionstring

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

ipv4
LoadBalancerNamestring

负载均衡实例的名称。

lb-bp1o94dp5i6ea****
Bandwidthinteger

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

  • -1:对于按流量计费的公网负载均衡实例,可以将带宽峰值设置为-1,即不限制带宽峰值。

  • 1~5120:对于按带宽计费的公网负载均衡实例,可以设置每个监听的带宽峰值,但所有监听的带宽峰值之和不能超过实例的带宽峰值。

-1
Addressstring

负载均衡实例服务地址。

100.XX.XX.28
SlaveZoneIdstring

实例的备可用区ID。

cn-hangzhou-d
MasterZoneIdstring

实例的主可用区ID。

cn-hangzhou-b
InternetChargeTypeAliasstring

公网计费方式。取值:

  • paybybandwidth:按带宽计费。

  • paybytraffic:按流量计费

PayType参数的值为PrePay时,只支持按带宽计费。当InstanceChargeType参数的值为PayByCLCU时,只支持按流量计费。

paybybandwidth
LoadBalancerSpecstring

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

slb.s1.small
RegionIdstring

负载均衡实例的地域ID。

cn-hangzhou
ModificationProtectionReasonstring

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

说明 仅在ModificationProtectionStatusConsoleProtection时有效。
托管实例
ModificationProtectionStatusstring

负载均衡修改保护状态:

  • NonProtection:不限制修改保护,设置后会清空之前设置的ModificationProtectionReason

  • ConsoleProtection:实例控制台修改保护状态。

说明 当取值为ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用API修改实例配置。
ConsoleProtection
VSwitchIdstring

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

vsw-255ecr****
LoadBalancerStatusstring

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

  • inactive:实例已停止,此状态的实例监听不会再转发流量。

  • active:实例运行中,实例创建后,默认状态为active

  • locked:实例已锁定,实例已经被锁定。

active
ResourceGroupIdstring

企业资源组ID。

rg-atstuj3r****
InternetChargeTypestring

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

  • 3:按带宽计费(paybybandwidth)。

  • 4:按流量计费(paybytraffic)。

PayType参数的值为PrePay时,只支持按带宽计费。当InstanceChargeType参数的值为PayByCLCU时,只支持按流量计费。

3
DeleteProtectionstring

负载均衡删除保护状态。取值:

  • on:开启。
  • off:关闭。
off
RegionIdAliasstring

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

hangzhou
Tagsobject []

标签列表

TagValuestring

标签值。

FinanceJoshua
TagKeystring

标签键。

FinanceDept
InstanceChargeTypestring

实例计费方式,取值:

  • 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": "hangzhou",
        "Tags": {
          "Tag": [
            {
              "TagValue": "FinanceJoshua",
              "TagKey": "FinanceDept"
            }
          ]
        },
        "InstanceChargeType": "PayBySpec"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-07-04OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Tag
  • 本页导读 (1)
文档反馈