更新时间:2022-03-31 GMT+08:00
分享

查询负载均衡器详情

功能介绍

查询负载均衡器详情。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

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

负载均衡器描述信息。

最小长度:1

最大长度:255

provisioning_status

String

负载均衡器的配置状态。取值:

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

admin_state_up

Boolean

负载均衡器的管理状态。固定为true。

provider

String

负载均衡器的生产者名称。固定为vlb。

pools

Array of PoolRef objects

负载均衡器直接关联的后端云服务器组的ID列表。

listeners

Array of ListenerRef objects

负载均衡器关联的监听器的ID列表。

operating_status

String

负载均衡器的操作状态。取值:

  • ONLINE:在线。

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。只支持绑定一个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

billing_info

String

资源账单信息。 取值:

  • 空:按需计费。

  • 非空:包周期计费,

包周期计费billing_info字段的格式为:order_id:product_id:region_id:project_id,如:

CS2107161019CDJZZ:OFFI569702121789763584:eu-de:057ef081eb00d2732fd1c01a9be75e6f

使用说明:

  • admin权限才能更新此字段。

最小长度:1

最大长度:1024

l4_flavor_id

String

四层Flavor ID。

hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:255

l4_scale_flavor_id

String

四层弹性Flavor ID。

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

最小长度:1

最大长度:255

l7_flavor_id

String

七层Flavor ID。

hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:255

l7_scale_flavor_id

String

七层弹性Flavor ID。

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

最小长度:1

最大长度:255

publicips

Array of PublicIpInfo objects

负载均衡器绑定的公网IP。只支持绑定一个公网IP。

注:该字段与eips一致。

elb_virsubnet_ids

Array of strings

下联面子网的网络ID列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。

使用说明:

  • 若不指定该字段,则会在当前负载均衡器所在子网作为下联面子网。

  • 若指定多个下联面子网,则按顺序优先使用第一个子网来为负载均衡器下联面端口分配ip地址。

  • 下联面子网必须属于该LB所在的VPC。

  • 不支持边缘云子网。

elb_virsubnet_type

String

下联面子网类型

  • ipv4:ipv4

  • dualstack:双栈

ip_target_enable

Boolean

是否启用跨VPC后端转发。开启跨VPC后端转发后,后端服务器组支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性。

frozen_scene

String

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

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

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

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

  • REAR:欠费冻结场景。

ipv6_bandwidth

BandwidthRef object

带宽对象ID,仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时,此EIP会被分进共享带宽里面。

deletion_protection_enable

Boolean

是否开启删除保护,取值:

  • false:不开启。

  • true:开启。

仅当前局点启用删除保护特性后才会返回该字段。

说明:

退场时需要先关闭所有资源的删除保护开关。

autoscaling

AutoscalingRef object

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

使用说明:

  • 仅当局点支持弹性扩缩特性才会返回该字段。

  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id不再起作用。

表5 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。

表6 ListenerRef

参数

参数类型

描述

id

String

监听器ID。

表7 Tag

参数

参数类型

描述

key

String

标签键

最小长度:1

最大长度:36

value

String

标签值

最小长度:0

最大长度:43

表8 EipInfo

参数

参数类型

描述

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

IP版本号,取值:4表示IPv4,6表示IPv6。

表9 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id

publicip_address

String

IP地址

ip_version

Integer

IP版本信息。 取值:

  • 4:IPv4

  • 6:IPv6

表10 BandwidthRef

参数

参数类型

描述

id

String

共享带宽的id

表11 AutoscalingRef

参数

参数类型

描述

enable

Boolean

当前负载均衡器是否开启弹性扩缩容。 取值:

  • true:开启。

  • false:不开启。

缺省值:false

min_l4_flavor_id

String

弹性扩缩容的最小四层规格ID,有四层监听器时,该字段不能为空。

最小长度:1

最大长度:36

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID,有七层监听器时,该字段不能为空。

最小长度:1

最大长度:36

请求示例

查询ELB详情

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" : "BETA",
    "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_l4_flavor" : "L4_flavor.elb.s1.small",
      "min_l7_flavor" : null
    }
  },
  "request_id" : "1a47cfbf-969f-4e40-8c0e-c2e60b14bcac"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close