更新时间:2026-01-16 GMT+08:00

查询负载均衡器详情

功能介绍

查询负载均衡器详情。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目ID。获取方式请参见获取项目ID

约束限制:不涉及

取值范围:长度为32个字符,由小写字母和数字组成。

默认取值:不涉及

loadbalancer_id

String

参数解释:负载均衡器ID。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

参数解释:请求ID。

取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。

loadbalancer

LoadBalancer object

参数解释:负载均衡器的详细信息。

表4 LoadBalancer

参数

参数类型

描述

id

String

参数解释:负载均衡器ID。

取值范围:不涉及

description

String

参数解释:负载均衡器描述信息。

取值范围:不涉及

provisioning_status

String

参数解释:负载均衡器的配置状态。

取值范围

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

admin_state_up

Boolean

参数解释:负载均衡器的启用状态。

取值范围

  • true :启用。

  • false:停用。

provider

String

参数解释:负载均衡器的生产者名称。固定为vlb。

取值范围:不涉及

pools

Array of PoolRef objects

参数解释:负载均衡器直接关联的后端服务器组的ID列表。

listeners

Array of ListenerRef objects

参数解释:负载均衡器关联的监听器的ID列表。

operating_status

String

参数解释:负载均衡器的操作状态。

取值范围

  • ONLINE:在线。

  • FROZEN:已冻结。

name

String

参数解释:负载均衡器的名称。

取值范围:不涉及

project_id

String

参数解释:负载均衡器所属的项目ID。

取值范围:不涉及

vip_subnet_cidr_id

String

参数解释:负载均衡器所在子网的IPv4子网ID,也称为该负载均衡器实例的前端子网。

取值范围:不涉及

vip_address

String

参数解释:负载均衡器的IPv4私网IP地址。

取值范围:不涉及

vip_port_id

String

参数解释:负载均衡器的IPv4对应的port ID。

取值范围:不涉及

tags

Array of Tag objects

参数解释:负载均衡的标签列表。

created_at

String

参数解释:负载均衡器的创建时间。

取值范围

格式:yyyy-MM-dd'T'HH:mm:ss'Z'

updated_at

String

参数解释:负载均衡器的更新时间。

取值范围

格式:yyyy-MM-dd'T'HH:mm:ss'Z'

guaranteed

Boolean

参数解释:是否独享型LB。

取值范围

  • false:共享型。

  • true:独享型。

vpc_id

String

参数解释:负载均衡器所在VPC ID。

取值范围:不涉及

eips

Array of EipInfo objects

参数解释:负载均衡器绑定的EIP。

说明:
该字段与publicips一致。

ipv6_vip_address

String

参数解释:双栈类型负载均衡器的IPv6地址。

取值范围:不涉及

ipv6_vip_virsubnet_id

String

参数解释:双栈类型负载均衡器所在子网的IPv6网络ID,也称为该负载均衡器实例的前端子网。

取值范围:不涉及

ipv6_vip_port_id

String

参数解释:双栈类型负载均衡器的IPv6对应的port ID。

取值范围:不涉及

availability_zone_list

Array of strings

参数解释:负载均衡器所在的可用区列表。

取值范围:不涉及

enterprise_project_id

String

参数解释:资源所属的企业项目ID。

取值范围

  • "0":表示资源属于default企业项目。

  • UUID格式的字符串,表示非默认企业项目。

billing_info

String

参数解释:资源账单信息。

取值范围

  • 空:按需计费。

不支持该字段,请勿使用。

l4_flavor_id

String

参数解释:负载均衡器4层规格ID。

若当前负载均衡器是弹性规格实例,则该字段表示4层上限规格。

取值范围:不涉及

l4_scale_flavor_id

String

参数解释:四层弹性规格ID。

取值范围:不涉及

说明:
该字段已经废弃,请勿使用。

l7_flavor_id

String

参数解释:负载均衡器7层规格ID。

若当前负载均衡器是弹性规格实例,则该字段表示7层上限规格。

取值范围:不涉及

l7_scale_flavor_id

String

参数解释:七层弹性Flavor ID。

取值范围:不涉及

说明:
该字段已经废弃,请勿使用。

gw_flavor_id

String

参数解释:网关型负载均衡器的规格ID。

取值范围:不涉及

不支持该字段,请勿使用。

loadbalancer_type

String

参数解释:负载均衡器类别。

取值范围

  • gateway 表示网关类型负载均衡器。

  • null 表示其他非网关类型负载均衡器。

不支持该字段,请勿使用。

publicips

Array of PublicIpInfo objects

参数解释:负载均衡器绑定的公网IP。

说明:
该字段与eips一致。

global_eips

Array of GlobalEipInfo objects

参数解释:负载均衡器绑定的global eip。

elb_virsubnet_ids

Array of strings

参数解释:下联面子网的网络ID列表。

取值范围:不涉及

elb_virsubnet_type

String

参数解释:下联面子网类型。

取值范围

  • ipv4:仅支持IPv4

  • dualstack:双栈,同时支持IPv4和IPv6。

ip_target_enable

Boolean

参数解释:是否启用IP类型后端转发。

取值范围

  • true:开启。

  • false:不开启。

frozen_scene

String

参数解释:负载均衡器的冻结场景。

若负载均衡器有多个冻结场景,用逗号分隔。

取值范围

  • ILLEGAL:违规冻结场景。

  • VERIFY:客户未实名认证冻结场景。

  • PARTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

  • ARREAR:欠费冻结场景。

deletion_protection_enable

Boolean

参数解释:是否开启删除保护。仅当前局点启用删除保护特性后才会返回该字段。

取值范围

  • false:不开启。

  • true:开启。

autoscaling

AutoscalingRef object

参数解释:弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。

说明:
该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

public_border_group

String

参数解释:公网边界组。

取值范围

  • center:表示中心站点的公网边界组

  • 边缘站点名称:表示边缘站点的公网边界组

不支持该字段,请勿使用。

charge_mode

String

参数解释:负载均衡器实例的计费模式。

取值范围

  • flavor:按规格计费。

  • lcu:按使用量计费。

  • 空值:若是共享型表示免费实例。若是独享型则与flavor模式一致,都是按规格计费。

不支持该字段,请勿使用。

service_lb_mode

String

参数解释:LB模式。

取值范围

  • lb:默认模式,不支持跨租户访问。

  • ep:ep模式,LB支持跨租户访问。

不支持该字段,请勿使用。

instance_type

String

参数解释:标识实例归属哪个内部服务。

取值范围:不涉及

不支持该字段,请勿使用。

instance_id

String

参数解释:标识实例绑定内部服务的实例id。

取值范围:不涉及

不支持该字段,请勿使用。

proxy_protocol_extensions

Array of ProxyProtocolExtension objects

参数解释:pp扩展。

不支持该字段,请勿使用。

waf_failure_action

String

参数解释:WAF故障时的流量处理策略。

取值范围:discard:丢弃,forward: 转发到后端。

不支持该字段,请勿使用。

custom_qos_limit

CustomQosLimit object

参数解释:弹性负载均衡器的规格的自定义限速信息。

不支持该字段,请勿使用。

表5 PoolRef

参数

参数类型

描述

id

String

参数解释:后端服务器组ID。

取值范围:不涉及

表6 ListenerRef

参数

参数类型

描述

id

String

参数解释:监听器ID。

取值范围:不涉及

表7 Tag

参数

参数类型

描述

key

String

参数解释:标签键。

取值范围:不涉及

value

String

参数解释:标签值。

取值范围:不涉及

表8 EipInfo

参数

参数类型

描述

eip_id

String

参数解释:弹性IP的ID。

取值范围:不涉及

eip_address

String

参数解释:弹性IP的IP地址。

取值范围:不涉及

ip_version

Integer

参数解释:IP版本号。

取值范围

  • 4:表示IPv4地址。

  • 6:表示IPv6地址。

表9 PublicIpInfo

参数

参数类型

描述

publicip_id

String

参数解释:弹性公网EIP的ID。

取值范围:不涉及

publicip_address

String

参数解释:EIP的IP地址。

取值范围:不涉及

ip_version

Integer

参数解释:IP版本信息。

取值范围

  • 4:IPv4地址。

  • 6:IPv6地址。

表10 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

参数解释:global eip的ID。

取值范围:不涉及

global_eip_address

String

参数解释:global eip的ip地址。

取值范围:不涉及

ip_version

Integer

参数解释:IP版本信息。

取值范围

  • 4,表示IPv4

  • 6,表示IPv6

表11 AutoscalingRef

参数

参数类型

描述

enable

Boolean

参数解释:当前负载均衡器是否开启弹性扩缩容。

取值范围

  • true:开启。

  • false:不开启。

min_l7_flavor_id

String

参数解释:弹性扩缩容的最小七层规格ID(规格类型L7_elastic)。

取值范围:不涉及

表12 ProxyProtocolExtension

参数

参数类型

描述

vip_address

String

参数解释:ipv4 vip地址。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

ipv6_vip_address

String

参数解释:ipv6 vip地址。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

extension

Extension object

参数解释:pp 扩展。

约束限制:不涉及

表13 Extension

参数

参数类型

描述

ep_id

String

参数解释:EP ID.

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

ep_service_id

String

参数解释:EP Service ID.

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

表14 CustomQosLimit

参数

参数类型

描述

l4

L4Limit object

参数解释:负载均衡实例的四层规格自定义限速信息。

l7

L7Limit object

参数解释:负载均衡实例的七层规格自定义限速信息。

表15 L4Limit

参数

参数类型

描述

connection

Integer

参数解释:负载均衡实例的四层规格的最大并发连接数限速值。

取值范围:不涉及

cps

Integer

参数解释:负载均衡实例的四层规格的每秒新建连接数限速值。

取值范围:不涉及

表16 L7Limit

参数

参数类型

描述

connection

Integer

参数解释:负载均衡实例的七层规格的最大并发连接数限速值。

取值范围:不涉及

cps

Integer

参数解释:负载均衡实例的七层规格的每秒新建连接数限速值。

取值范围:不涉及

请求示例

查询指定负载均衡器的详情信息

GET https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/3dbde7e5-c277-4ea3-a424-edd339357eff

响应示例

状态码:200

操作正常返回。

{
  "loadbalancer" : {
    "id" : "3dbde7e5-c277-4ea3-a424-edd339357eff",
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "name" : "elb-l4-no-delete",
    "description" : null,
    "vip_port_id" : "f079c7ee-65a9-44ef-be86-53d8927e59be",
    "vip_address" : "10.0.0.196",
    "admin_state_up" : true,
    "provisioning_status" : "ACTIVE",
    "operating_status" : "ONLINE",
    "listeners" : [ ],
    "pools" : [ {
      "id" : "1d864dc9-f6ef-4366-b59d-7034cde2328f"
    }, {
      "id" : "c0a2e4a1-c028-4a24-a62f-e721c52f5513"
    }, {
      "id" : "79308896-6169-4c28-acbc-e139eb661996"
    } ],
    "tags" : [ ],
    "provider" : null,
    "created_at" : "2019-12-02T09:55:11Z",
    "updated_at" : "2019-12-02T09:55:11Z",
    "vpc_id" : "70711260-9de9-4d96-9839-0ae698e00109",
    "enterprise_project_id" : "0",
    "availability_zone_list" : [ ],
    "ipv6_vip_address" : null,
    "ipv6_vip_virsubnet_id" : null,
    "ipv6_vip_port_id" : null,
    "publicips" : [ ],
    "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ],
    "eips" : [ ],
    "guaranteed" : true,
    "billing_info" : null,
    "l4_flavor_id" : "e5acacda-f861-404e-9871-df480c49d185",
    "l4_scale_flavor_id" : null,
    "l7_flavor_id" : null,
    "l7_scale_flavor_id" : null,
    "vip_subnet_cidr_id" : "396d918a-756e-4163-8450-3bdc860109cf",
    "deletion_protection_enable" : false,
    "autoscaling" : {
      "enable" : true,
      "min_l7_flavor_id" : "0c8cf29d-51cb-4c1d-8e25-1c61cf5c2b00"
    },
    "public_border_group" : "center"
  },
  "request_id" : "1a47cfbf-969f-4e40-8c0e-c2e60b14bcac"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码