负载均衡器

列举负载均衡器

功能介绍

查询负载均衡器列表。

URI

GET /v2.0/lbaas/loadbalancers

请求消息

参数	参数类型	是否必选	描述
fields	string	否	你想让服务器返回的字段。如果没有指定字段的查询参数，API会返回所有负载均衡器的属性。通过使用`fields`参数，API只返回请求的属性集。可以指定多个字段的参数。例如，如果您指定`fields=id&fields=name`的请求URL，那么只有`id`和`name`属性将返回。
project_id	string	否	指定项目ID进行查询。

响应消息

参数	参数类型	描述
additional_vips	array	负载均衡器绑定的附加VIP对象列表。
admin_state_up	boolean	负载均衡器的管理状态。true表示启用，false表示停用。
availability_zone	object	负载均衡可用区名称。
created_at	string	负载均衡器创建的时间。
description	string	负载均衡器的描述。
flavor_id	uuid	负载均衡规格的ID。
id	uuid	负载均衡器的ID。
listeners	array	负载均衡器关联的监听器的ID。
loadbalancers	array	`loadbalancer`对象列表。
lvs_tcp_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的连接超时时间。
lvs_tcpfin_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的FIN_WAIT状态超时时间。
lvs_udp_timeout	integer	属于此负载均衡器的UDP监听器的连接的空闲超时时间。
name	string	负载均衡器的名称。
operating_status	string	负载均衡器的运行状态。
pools	array	负载均衡器关联的资源池ID。
project_id	string	负载均衡器所属的项目ID。
provider	string	负载均衡器的提供者名称。
provisioning_status	string	负载均衡器的配置状态。
tags	list	标签。
updated_at	string	负载均衡器最后一次更新的时间
vip_address	string	VIP的IP地址。
vip_network_id	uuid	VIP的网络ID。
vip_port_id	uuid	VIP端口的ID。
vip_qos_policy_id	uuid	VIP的QoS策略的ID。
vip_subnet_id	uuid	VIP的子网ID。

请求示例

curl -X GET http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers  -H "X-Auth-Token: <token>"

正常响应示例

{
    "loadbalancers": [
        {
            "id": "f02eb538-72fe-454d-9c72-00a47fff89e8",
            "name": "loadbalancer_myBnPf",
            "description": "",
            "provisioning_status": "ACTIVE",
            "operating_status": "ONLINE",
            "admin_state_up": true,
            "project_id": "15c639b06203466098da039e0de47f7e",
            "created_at": "2022-03-14T08:12:47",
            "updated_at": "2022-03-14T12:00:53",
            "vip_address": "192.168.111.84",
            "vip_port_id": "9ae55dd3-e4f4-4fca-b69a-ede3a311d2b4",
            "vip_subnet_id": "cc746da5-67d6-49c6-bfca-8be9fb4985e4",
            "vip_network_id": "0f93d3e9-7796-4f60-b5ad-f9da235dd271",
            "additional_vips": [
                {
                    "subnet_id": "f4a7c195-36b9-4f3a-9f27-25c7c35356d5",
                    "ip_address": "2000::b5"
                }
            ],
            "listeners": [
                {
                    "id": "ba618d92-299b-4319-80b6-2d7f23913781"
                }
            ],
            "pools": [
                {
                    "id": "743da04e-b1be-4a00-9400-f35aa247e5b1"
                }
            ],
            "provider": "amphora",
            "flavor_id": "3fb985bc-1915-4972-b430-1451e0174109",
            "vip_qos_policy_id": null,
            "tags": [],
            "availability_zone": "octavia-az-061723b0-8240-4d0c-ab5d-e4307dba51b6",
            "lvs_tcp_timeout": 300,
            "lvs_tcpfin_timeout": 120,
            "lvs_udp_timeout": 300,
            "tenant_id": "15c639b06203466098da039e0de47f7e"
        }
    ],
    "loadbalancers_links": []
}

正常响应代码

200

错误码

400，401，500

‎创建负载均衡器

功能介绍

‎创建一个负载均衡器

URI

POST /v2.0/lbaas/loadbalancers

请求消息

参数	参数类型	是否必选	描述
admin_state_up	boolean	否	负载均衡器的管理状态。true表示启用，false表示停用。
availability_zone	object	是	负载均衡可用区名称。（创建负载均衡器前需要依次创建独立的负载均衡可用区配置、负载均衡可用区）
description	string	否	负载均衡器的描述。
flavor_id	uuid	是	负载均衡规格ID。（创建负载均衡器前需要依次创建独立的负载均衡规格配置，负载均衡规格）
listeners	array	否	负载均衡器关联的监听器ID。
loadbalancer	object	是	`loadbalancer`对象。
lvs_tcp_timeout	integer	否	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的连接超时时间。
lvs_tcpfin_timeout	integer	否	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的FIN_WAIT状态超时时间。
lvs_udp_timeout	integer	否	属于此负载均衡器的UDP监听器的连接的空闲超时时间。
name	string	否	负载均衡器的名称。
project_id	string	否	此负载均衡器所属的项目ID。
provider	string	否	负载均衡器的提供者名称。默认是octavia。
tags	list	否	标签。
vip_address	string	否	VIP的IP地址。
vip_network_id	uuid	否	VIP的网络ID。
vip_port_id	uuid	否	VIP端口的ID。
vip_qos_policy_id	uuid	否	VIP的QoS策略的ID。
vip_subnet_id	uuid	否	VIP的子网ID。

响应消息

参数	参数类型	描述
admin_state_up	boolean	负载均衡器的管理状态。true表示启用，false表示停用。
availability_zone	object	负载均衡可用区名称。
created_at	string	负载均衡器创建的时间。
description	string	资源的描述。
flavor_id	uuid	负载均衡规格的ID。
id	uuid	负载均衡器的ID。
listeners	array	负载均衡器关联的监听器ID。
loadbalancer	object	`loadbalancer`对象。
lvs_tcp_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的连接超时时间。
lvs_tcpfin_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的FIN_WAIT状态超时时间。
lvs_udp_timeout	integer	属于此负载均衡器的UDP监听器的连接的空闲超时时间。
name	string	负载均衡器的名称。
operating_status	string	负载均衡器的运行状态。
pools	array	负载均衡器关联的资源池ID。
project_id	string	负载均衡器所属的项目ID。
provider	string	负载均衡器的提供者名称。
provisioning_status	string	负载均衡器的配置状态。
tags	list	标签。
updated_at	string	负载均衡器最后一次更新的时间
vip_address	string	VIP的IP地址。
vip_network_id	uuid	VIP的网络ID。
vip_port_id	uuid	VIP端口的ID。
vip_qos_policy_id	uuid	VIP的QoS策略的ID。
vip_subnet_id	uuid	VIP的子网ID。

请求示例

curl -X POST http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers   -H "X-Auth-Token: <token>" -d '{"loadbalancer": {"description": "This a demo loadbalancer.", "admin_state_up": true, "project_id": "e3cd678b11784734bc366148aa37580e", "flavor_id": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", "vip_subnet_id": "f390780c-8a5d-472e-9b2d-6b0caa5f9f5d", "vip_address": "192.168.1.3", "provider": "amphora", "name": "demo-lb", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", "availability_zone": "default_az", "tags": ["test_tag"]}}'

{
    "loadbalancer": {
        "description": "This a demo loadbalancer.",
        "admin_state_up": true,
        "project_id": "e3cd678b11784734bc366148aa37580e",
        "vip_subnet_id": "f390780c-8a5d-472e-9b2d-6b0caa5f9f5d",
        "vip_address": "192.168.1.3",
        "provider": "amphora",
        "name": "demo-lb",
        "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
        "availability_zone": "default_az",
        "tags": ["test_tag"]
    }
}

正常响应示例

{
    "loadbalancer": {
        "description": "This a demo loadbalancer.",
        "admin_state_up": true,
        "project_id": "e3cd678b11784734bc366148aa37580e",
        "provisioning_status": "PENDING_CREATE",
        "flavor_id": "",
        "vip_subnet_id": "f390780c-8a5d-472e-9b2d-6b0caa5f9f5d",
        "vip_address": "192.168.1.3",
        "vip_network_id": "d0d217df-3958-4fbf-a3c2-8dad2908c709",
        "vip_port_id": "b4ca07d1-a31e-43e2-891a-7d14f419f342",
        "provider": "amphora",
        "created_at": "2017-02-28T00:41:44",
        "updated_at": "2017-02-28T00:43:30",
        "id": "607226db-27ef-4d41-ae89-f2a800e9c2db",
        "operating_status": "OFFLINE",
        "name": "demo-lb",
        "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
        "availability_zone": "default_az",
        "lvs_tcp_timeout": 300,
        "lvs_tcpfin_timeout": 120,
        "lvs_udp_timeout": 300,
        "tags": ["test_tag"]
    }
}

正常响应代码

201

错误码

400，401，403，404，500，503

查询负载均衡器详情

功能介绍

‎查询一个负载均衡器详情。

URI

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

参数	是否必选	描述
loadbalancer_id	是	待查询的负载均衡器的ID

请求消息

参数	参数类型	是否必选	描述
fields	string	否	你想让服务器返回的字段。如果没有指定字段的查询参数，API会返回所有负载均衡器的属性。通过使用`fields`参数，API只返回请求的属性集。可以指定多个字段的参数。例如，如果您指定`fields=id&fields=name`的请求URL，那么只有`id`和`name`属性将返回。

响应消息

参数	参数类型	描述
additional_vips	array	负载均衡器绑定的附加VIP对象列表。
admin_state_up	boolean	负载均衡器的管理状态。true表示启用，false表示停用。
availability_zone	object	负载均衡可用区名称。通过负载均衡可用区可以关联到负载均衡可用区配置，在availability_zone_data中可以通过compute_zone指定使用计算的可用区。
created_at	string	负载均衡器创建的时间。
description	string	负载均衡器的描述。
flavor_id	uuid	负载均衡规格的ID。通过负载均衡规格可以关联到负载均衡规格配置，在flavor_data中可以通过compute_flavor指定使用计算的规格。
id	uuid	负载均衡器的ID。
listeners	array	负载均衡器关联的监听器的ID。
loadbalancer	object	`loadbalancer`对象。
lvs_tcp_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的连接超时时间。
lvs_tcpfin_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的FIN_WAIT状态超时时间。
lvs_udp_timeout	integer	属于此负载均衡器的UDP监听器的连接的空闲超时时间。
name	string	负载均衡器的名称。
operating_status	string	负载均衡器的运行状态。
pools	array	负载均衡器关联的资源池ID。
project_id	string	负载均衡器所属的项目ID。
provider	string	负载均衡器的提供者名称。
provisioning_status	string	负载均衡器的配置状态。
tags	list	标签。
updated_at	string	负载均衡器最后一次更新的时间
vip_address	string	VIP的IP地址。
vip_network_id	uuid	VIP的网络ID。
vip_port_id	uuid	VIP端口的ID。
vip_qos_policy_id	uuid	VIP的QoS策略的ID。
vip_subnet_id	uuid	VIP的子网ID。

请求示例

curl -X GET http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/4deb934d-7e2b-49eb-8840-b40b85c1b5e8  -H "X-Auth-Token: <token>"

正常响应示例

{
  "loadbalancer": {
    "id": "4deb934d-7e2b-49eb-8840-b40b85c1b5e8",
    "name": "demo-lb",
    "description": "",
    "provisioning_status": "ERROR",
    "operating_status": "DEGRADED",
    "admin_state_up": true,
    "project_id": "4316daeb7dd447038247537adf97808a",
    "created_at": "2022-04-13T03:00:55",
    "updated_at": "2022-04-15T06:31:56",
    "vip_address": "192.168.111.117",
    "vip_port_id": "3d983274-432f-440e-944d-ecfb03d790af",
    "vip_subnet_id": "d065b701-9faa-4af0-9323-3614c2472db8",
    "vip_network_id": "9fa00d25-1a3a-458e-9f85-001afc53d7c0",
    "additional_vips": [
      {
        "subnet_id": "f4a7c195-36b9-4f3a-9f27-25c7c35356d5",
        "ip_address": "2000::b5"
      }
    ],
    "listeners": [
      {
        "id": "f18f2ed2-5a8f-4c41-97c2-82e6af88605b"
      }
    ],
    "pools": [
      {
        "id": "993ce277-b57d-4ffa-98dc-3da740a92f61"
      }
    ],
    "provider": "amphora",
    "flavor_id": "23aa97ce-6883-4bda-a54d-a92cc3d0347d",
    "vip_qos_policy_id": null,
    "tags": [],
    "availability_zone": "octavia-az-e9dd85df-865f-4305-b3f3-23b802b44b5c",
    "lvs_tcp_timeout": 300,
    "lvs_tcpfin_timeout": 120,
    "lvs_udp_timeout": 300,
    "tenant_id": "4316daeb7dd447038247537adf97808a"
  }
}

正常响应代码

200

错误码

401，403，404，500

更新负载均衡器

功能介绍

更新一个负载均衡器

URI

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

参数	是否必选	描述
loadbalancer_id	是	待更新的负载均衡器的ID

请求消息

参数	参数类型	是否必选	描述
admin_state_up	boolean	否	负载均衡器的管理状态。true表示启用，false表示停用。
description	string	否	负载均衡器的描述。
loadbalancer	object	是	`loadbalancer`对象。
name	string	否	负载均衡器的名称。
tags	list	否	标签。
vip_qos_policy_id	uuid	否	VIP的QoS策略的ID。

响应消息

参数	参数类型	描述
additional_vips	array	负载均衡器绑定的附加VIP对象列表。
admin_state_up	boolean	负载均衡器的管理状态。true表示启用，false表示停用。
created_at	string	负载均衡器的创建的时间。
description	string	负载均衡器的描述。
flavor_id	uuid	负载均衡规格的ID。
id	uuid	负载均衡器的ID。
listeners	array	负载均衡器关联的监听器ID。
loadbalancer	object	`loadbalancer`对象。
lvs_tcp_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的连接超时时间。
lvs_tcpfin_timeout	integer	属于此负载均衡器的FORWARD_TCP即TCP（性能模式）监听器的FIN_WAIT状态超时时间。
lvs_udp_timeout	integer	属于此负载均衡器的UDP监听器的连接的空闲超时时间。
name	string	负载均衡器的名称。
operating_status	string	负载均衡器的运行状态。
pools	array	负载均衡器关联的资源池ID。
project_id	string	负载均衡器所属的项目ID。
provider	string	负载均衡器的提供者名称。
provisioning_status	string	负载均衡器的配置状态。
tags	list	标签。
updated_at	string	负载均衡器最后一次更新的时间
vip_address	string	VIP的IP地址。
vip_network_id	uuid	VIP的网络ID。
vip_port_id	uuid	VIP端口的ID。
vip_qos_policy_id	uuid	VIP的QoS策略的ID。
vip_subnet_id	uuid	VIP的子网ID。

请求示例

curl -X PUT http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/7952e810-cfa0-4206-8ae3-594e3d0869e0   -H "X-Auth-Token: <token>" -d '{"loadbalancer": {"name": "demo-lb", "description": "This a demo loadbalancer."}}'

{
  "loadbalancer": {
    "name": "demo-lb",
    "description": "This a demo loadbalancer."
  }
}

正常响应示例

{
  "loadbalancer": {
    "id": "7952e810-cfa0-4206-8ae3-594e3d0869e0",
    "name": "demo-lb",
    "description": "This a demo loadbalancer.",
    "provisioning_status": "PENDING_UPDATE",
    "operating_status": "ONLINE",
    "admin_state_up": true,
    "project_id": "4316daeb7dd447038247537adf97808a",
    "created_at": "2022-04-13T02:44:06",
    "updated_at": "2022-04-15T06:35:40",
    "vip_address": "192.168.111.29",
    "vip_port_id": "58da5cf6-9270-425e-b8fc-27da50fcd0b9",
    "vip_subnet_id": "d065b701-9faa-4af0-9323-3614c2472db8",
    "vip_network_id": "9fa00d25-1a3a-458e-9f85-001afc53d7c0",
    "additional_vips": [
      {
        "subnet_id": "f4a7c195-36b9-4f3a-9f27-25c7c35356d5",
        "ip_address": "2000::b5"
      }
    ],
    "listeners": [
      {
        "id": "bc519e94-6d1e-4139-aa52-66699aaf0611"
      },
      {
        "id": "06fec847-d7e4-4399-b862-b60eb9ea1e92"
      },
      {
        "id": "c219e81a-9dd5-4ae6-8435-13e99bd5b77a"
      }
    ],
    "pools": [
      {
        "id": "4a52eec6-e37a-42e3-a235-20b0b4984259"
      },
      {
        "id": "5bb90d2f-0962-4b01-967d-022838a9648d"
      },
      {
        "id": "ff4660d9-e1b9-4b5d-a5a6-6190f913524e"
      }
    ],
    "provider": "amphora",
    "flavor_id": "a5804627-622d-4571-8986-48ef62c91d36",
    "vip_qos_policy_id": null,
    "tags": [],
    "availability_zone": "octavia-az-9b071b46-09ae-43a3-b7ca-92cc72d37660",
    "lvs_tcp_timeout": 300,
    "lvs_tcpfin_timeout": 120,
    "lvs_udp_timeout": 300,
    "tenant_id": "4316daeb7dd447038247537adf97808a"
  }
}

正常响应代码

202

错误码

400，401，403，404，409，500

‎删除负载均衡器

功能介绍

删除一个负载均衡器

URI

DELETE /v2.0/lbaas/{loadbalancer_id}

参数	是否必选	描述
loadbalancer_id	是	待删除的负载均衡器的ID

请求消息

参数	参数类型	是否必选	Description
cascade	boolean	否	如果值为true，删除负载均衡器时将级联删除该负载均衡器的子资源。

请求示例

curl -X DELETE "http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/4deb934d-7e2b-49eb-8840-b40b85c1b5e8?cascade=True"  -H "X-Auth-Token: <token>"

正常响应代码

204

错误码

400，401，403，404，409，500

获取负载均衡器统计信息

功能介绍

获取一个负载均衡器的统计信息

URI

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

参数	是否必选	描述
loadbalancer_id	是	待查询的负载均衡器的ID

响应消息

参数	参数类型	描述
stats	object	负载均衡器的统计信息对象。
active_connections	integer	当前活跃的连接数。
bytes_in	integer	接收的总字节数。
bytes_out	integer	发送的总字节数。
request_errors	integer	无法满足的请求总数。
total_connections	integer	处理的总连接数。

请求示例

curl -X GET http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/7952e810-cfa0-4206-8ae3-594e3d0869e0/stats  -H "X-Auth-Token: <token>"

正常响应示例

{
  "stats": {
    "bytes_in": 138198,
    "bytes_out": 1623311,
    "active_connections": 0,
    "total_connections": 1488,
    "request_errors": 3
  }
}

正常响应代码

200

错误码

400，401，403，404，500

负载均衡器故障转移

功能介绍

重置负载均衡器，完成故障转移。

URI

PUT /v2.0/lbaas/loadbalancers/{loadbalancer_id}/failover

参数	是否必选	描述
loadbalancer_id	是	待故障转移的负载均衡器的ID。

请求消息

无

响应消息

无

请求示例

curl -X PUT http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/4deb934d-7e2b-49eb-8840-b40b85c1b5e8/failover  -H "X-Auth-Token: <token>"

正常响应示例

无

正常响应代码

202

错误码

401，403，404，409，500

导出负载均衡器

功能介绍

导出一个或多个负载均衡器的配置。响应使用Provider数据模型格式，可包含监听器、默认资源池、成员、L7策略和L7重定向资源池等嵌套配置。

URI

GET /v2.0/lbaas/loadbalancers/{loadbalancer_ids}/export

参数	是否必选	描述
loadbalancer_ids	是	待导出的负载均衡器ID。多个ID使用英文逗号分隔。

请求消息

参数	参数类型	是否必选	描述
project_id	string	否	指定项目ID进行过滤。

接口约束

响应使用loadbalancer_id、listener_id、pool_id和member_id等Provider字段名。
不存在的负载均衡器ID会被跳过；没有匹配项时返回空的loadbalancers列表。
Listener导出对象包含listener_ip；嵌套Pool当前不包含ip_version，恢复IPv6资源池时需要补充该字段。
additional_vips可能返回空列表，恢复附加VIP配置时应结合Listener的listener_ip和原网络信息核对。
TERMINATED_HTTPS监听器的导出结果可能包含证书、私钥和口令等敏感数据，应按敏感凭据保存和传输。

响应消息

参数	参数类型	描述
loadbalancers	array	导出的负载均衡器对象列表。
loadbalancer_id	uuid	负载均衡器ID。
listeners	array	监听器配置列表。
listener_id	uuid	监听器ID。
listener_ip	string	监听器实际监听的IPv4或IPv6地址。
default_pool	object	默认资源池配置，可包含健康检查器和成员。
l7policies	array	L7策略列表，可包含规则和重定向资源池。

请求示例

curl -X GET "http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/0b7c5ec8-1f96-49d3-b2b1-7f68ba3aa03f/export" -H "X-Auth-Token: <token>"

多个负载均衡器可使用英文逗号分隔：

curl -X GET "http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/loadbalancers/0b7c5ec8-1f96-49d3-b2b1-7f68ba3aa03f,17e9442b-4d7e-481e-9bf6-56495ff01c6d/export" -H "X-Auth-Token: <token>"

正常响应示例

{
  "loadbalancers": [
    {
      "project_id": "250a86f0dcc9467285fa8af54457e885",
      "name": "demo-lb",
      "loadbalancer_id": "0b7c5ec8-1f96-49d3-b2b1-7f68ba3aa03f",
      "vip_address": "192.168.0.10",
      "additional_vips": [],
      "listeners": [
        {
          "listener_id": "e05cde88-4580-4e2b-a94a-bef5b64889f3",
          "loadbalancer_id": "0b7c5ec8-1f96-49d3-b2b1-7f68ba3aa03f",
          "protocol": "HTTP",
          "listener_ip": "192.168.0.10",
          "protocol_port": 80,
          "default_pool": {
            "pool_id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3",
            "protocol": "HTTP",
            "members": [
              {
                "member_id": "2f97853a-e149-4a03-b057-2d91d8702197",
                "address": "192.168.0.20",
                "protocol_port": 80
              }
            ]
          },
          "l7policies": []
        }
      ]
    }
  ]
}

正常响应代码

200

错误码

400，401，403，500

日期	修订内容