文档首页/ 虚拟私有云 VPC/ API参考/ API/ 查询网络IP使用情况/ 查询网络IP使用情况
更新时间：2023-09-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询网络IP使用情况

功能介绍

显示一个指定网络中的IP地址使用情况。

包括此网络中的IP总数以及已用IP总数，以及网络下每一个子网的IP地址总数和已用IP地址总数。

  • 系统预留地址指的是子网的第1个以及最后2个地址，一般用于网关、DHCP等服务。
  • 这里以及下文描述的IP地址总数、已用IP地址总数不包含系统预留地址。
  • 在分配IP时，用户可以指定系统预留的IP地址。但是不论IP是如何分配的，只要是处于系统预留IP地址段的IP均不会被统计到已用IP地址数目和IP地址总数中。

URI

GET /v2.0/network-ip-availabilities/{network_id}

参数说明请参见表1。
表1 参数说明

参数名称

类型

必选

说明

network_id

String

是

网络的ID

说明：

network_id指调用VPC子网接口时，使用的子网ID。

更多信息请参见VPC子网接口与OpenStack Neutron子网接口的区别是什么？。

请求参数

无

请求示例

GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043

响应参数

表2 响应参数

名称

参数类型

说明

network_ip_availability

network_ip_availability object

network_ip_avalability对象，请参见表3。
表3 network_ip_availability对象

名称

参数类型

说明

network_id

String

网络ID

network_name

String

网络名称

tenant_id

String

项目ID

total_ips

Integer

网络中IP总数（不包含系统预留地址）

used_ips

Integer

网络中已经使用的IP数目（不包含系统预留地址）

subnet_ip_availability

Array of subnet_ip_availability objects

子网IP使用情况的对象，参见表4。
表4 subnet_ip_availability对象说明

参数名称

参数类型

说明

used_ips

Integer

子网中已经使用的IP数目（不包含系统预留地址）

subnet_id

String

子网ID

如果您使用管理控制台，此值即为子网详情中的“网络ID”参数值。

subnet_name

String

子网名称

ip_version

Integer

子网的IP版本，只支持Iv4

cidr

String

子网的CIDR

total_ips

Integer

子网中IP总数（不包含系统预留地址）

响应示例

{
  "network_ip_availability": {
    "used_ips": 4,
    "subnet_ip_availability": [
      {
        "used_ips": 4,
        "subnet_id": "98e343d1-3cb8-4f69-9cd1-00569819480f",
        "subnet_name": "",
        "ip_version": 4,
        "cidr": "10.0.0.0/8",
        "total_ips": 300
      }
    ],
    "network_id": "6b50d967-779c-40c9-a157-de1df3c17043",
    "tenant_id": "7c4b23cb125d481c95cbe4f91b2c11cd",
    "total_ips": 300,
    "network_name": "pch_test_003"
  }
}

状态码

请参见状态码。

错误码

请参考错误码。