文档首页> 弹性负载均衡 ELB> API参考> API（V3）> 预占IP> 计算预占IP数
更新时间：2024-04-18 GMT+08:00
在线调试
CLI示例
查看PDF

计算预占IP数

功能介绍

计算以下几种场景的预占用IP数量：

  • 计算创建LB的第一个七层监听器后总占用IP数量： 传入loadbalancer_id、l7_flavor_id为空、ip_target_enable不传或为false。

  • 计算LB规格变更或开启跨VPC后总占用IP数量： 传入参数loadbalancer_id，及l7_flavor_id不为空或ip_target_enable为true。

  • 计算创建LB所需IP数量：传入参数availability_zone_id， 及可选参数l7_flavor_id、ip_target_enable、ip_version，不能传loadbalancer_id。

说明：

  • 计算出来的预占IP数大于等于最终实际占用的IP数。

  • 总占用IP数量，即整个LB所占用的IP数量。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/elb/preoccupy-ip-num

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

所属项目id。
表2 Query参数

参数

是否必选

参数类型

描述

l7_flavor_id

否

String

负载均衡器七层规格的ID。传入该字段表示计算创建该规格的LB，或变更LB的原七层规格到该规格所需要的预占IP。

适用场景：创建负LB，变更LB规格。

ip_target_enable

否

Boolean

是否开启跨VPC转发。

取值true表示计算创建或变更为开启跨VPC转发的LB的预占IP。

取值false表示计算创建或变更为不开启跨VPC转发的LB的预占IP。不传等价false。

适用场景：创建LB，变更LB规格。

ip_version

否

Integer

负载均衡器IP地址类型，取值4，6 。

取值4表示计算创建支持IPv4地址的LB的预占IP。

取值6表示计算创建支持IPv6地址的LB的预占IP。

适用场景：创建LB。

loadbalancer_id

否

String

负载均衡器ID。计算LB规格变更或创建LB中的第一个七层监听器的预占IP。

适用场景：变更LB规格，创建LB中的第一个七层监听器。

availability_zone_id

否

Array

计算创建AZ列表为availability_zone_id的负载局衡器实例的预占IP。

适用场景：创建LB。

使用说明：传入loadbalancer_id时，该参数无效。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM鉴权Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

preoccupy_ip

PreoccupyIp object

预占IP信息

request_id

String

请求ID。

注：自动生成 。
表5 PreoccupyIp

参数

参数类型

描述

total

Integer

预占IP总数

请求示例

  • 查询变更负载均衡的七层规格需要预占的ip数

    https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/preoccupy-ip-num?loadbalancer_id=aff4fc31-d635-4f59-a862-edadf32e407d&l7_flavor_id=0051bc4c-a562-4b7c-953b-a250b51d992b

{
  "preoccupy_ip" : {
    "total" : 6
  },
  "request_id" : "8844e9a0-6a2d-44b7-aad9-15a7f75e4059"
}

  • 查询创建一个双az且开启跨VPC的负载均衡需要预占的IP数

    GET /v3/{project_id}/elb/preoccupy-ip-num?l7_flavor_id=8278944d-f92c-4393-82b2-6fb9cc1d7e53&availability_zone_id=az1&availability_zone_id=az2&ip_target_enable=true

{
  "preoccupy_ip" : {
    "total" : 20
  },
  "request_id" : "63388ec8-fa3c-4c99-b9c8-d2c83b2a9a68"
}

  • 查询指定负载均衡中创建第一个7层监听器所需预占的IP数

    GET /v3/{project_id}/elb/preoccupy-ip-num?loadbalancer_id=aff4fc31-d635-4f59-a862-edadf32e407d

{
  "preoccupy_ip" : {
    "total" : 2
  },
  "request_id" : "febfce48-318d-45ba-a9d9-855462123f3b"
}

响应示例

状态码： 200

操作正常返回。

{
  "preoccupy_ip" : {
    "total" : 20
  },
  "request_id" : "63388ec8-fa3c-4c99-b9c8-d2c83b2a9a68"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码。

父主题： 预占IP