更新时间:2024-01-23 GMT+08:00

查询负载均衡详情

功能介绍

根据指定负载均衡器ID,查询负载均衡器详情。同时可以根据查询到的vip_port_id,查询负载均衡器绑定的EIP。

URI

GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}

表1 参数说明

参数

是否必选

参数类型

描述

loadbalancer_id

String

负载均衡器ID。

请求消息

响应消息

表2 响应参数

参数

参数类型

描述

loadbalancer

Object

负载均衡器对象。详见表3

表3 loadbalancer字段说明

参数

是否必选

参数类型

描述

name

String

负载均衡器名称。

支持的最大字符长度:255

description

String

负载均衡器的描述信息。

支持的最大字符长度:255

provisioning_status

String

该字段为预留字段,暂未启用。

负载均衡器的配置状态。取值范围:可以为ACTIVE。

tenant_id

String

负载均衡器所在的项目ID。

支持的最大字符长度:255

需要和token中的project_id一致。

project_id

String

此参数和tenant_id参数含义一样,均指负载均衡器所在的项目ID。

需要和token中的project_id一致。

vip_subnet_id

String

负载均衡器所在的子网IPv4子网ID。可通过查询子网列表接口GET {vpc的endpoint}/v2.0/subnets获取。

vip_address将从该子网中产生。

只支持指定IPv4的子网ID。暂不支持IPv6。

provider

String

负载均衡器的生产者。

取值范围:vlb。

vip_address

String

负载均衡器的内网IP。

该IP必须为vip_subnet_id字段指定的子网网段中的IP。若不指定,自动从vip_subnet_id字段指定的子网网段中生成一个IP地址。

支持的最大字符长度:64

admin_state_up

Boolean

负载均衡器的管理状态。

该字段为预留字段,暂未启用。默认为true。

表4 listeners字段说明

参数

参数类型

描述

id

String

关联的监听器id

表5 pools字段说明

参数

参数类型

描述

id

String

关联的后端服务器组id

请求示例

  • 请求样例1 根据负载均衡器ID查询负载均衡器详情
  • 请求样例2 查询负载均衡器关联的弹性公网IP(EIP) 详细操作请参考查询弹性公网IP列表
    GET https://{EIP_Endpoint}/v1/{project_id}/publicips?port_id={vip_port_id}

    其中vip_port_id参数为弹性负载均衡的vip_port_id属性的值。

响应示例

  • 响应样例1
    {
        "loadbalancer": {
            "description": "",
            "admin_state_up": true,
            "tenant_id": "1867112d054b427e808cc6096d8193a1",
            "project_id": "1867112d054b427e808cc6096d8193a1",
            "provisioning_status": "ACTIVE",
            "vip_subnet_id": "4f5e8efe-fbbe-405e-b48c-a41202ef697c",
            "listeners": [
                {
                    "id": "09e64049-2ab0-4763-a8c5-f4207875dc3e"
                }
            ],
            "vip_address": "192.168.2.4",
            "vip_port_id": "c7157e7a-036a-42ca-8474-100be22e3727",
            "provider": "vlb",
            "pools": [
                {
                    "id": "b7e53dbd-62ab-4505-a280-5c066078a5c9"
                }
            ],
            "id": "3d77894d-2ffe-4411-ac0a-0d57689779b8",
            "operating_status": "ONLINE",
            "tags": [],
            "name": "lb-2",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    }
  • 响应样例2
    {
        "publicips": [
            {
                "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                "status": "DOWN",
                "profile": {
                  "user_id": "35f2b308f5d64441a6fa7999fbcd4321",
                  "product_id": "00301-48027-0--0",
                  "region_id": "xxx",
                  "order_id": "xxxxxxxxx"
                },
                "type": "5_bgp",
                "public_ip_address": "161.xx.xx.9",
                "private_ip_address": "192.168.2.4",
                "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
                "create_time": "2015-07-16 04:22:32",
                "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
                "bandwidth_share_type": "PER",
                "bandwidth_size": 5,
                "bandwidth_name": "bandwidth-test",
                "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
                "ip_version": 4,
                "port_id": "c7157e7a-036a-42ca-8474-100be22e3727"
            }
        ]
    }

    其中public_ip_address就是弹性负载均衡绑定的弹性公网IP地址。

返回码

请参见状态码