華為云計算 云知識 查詢網絡IP使用情況ShowNetworkIpAvailabilities
查詢網絡IP使用情況ShowNetworkIpAvailabilities

 

功能介紹

顯示一個指定網絡中的IP地址使用情況。

包括此網絡中的IP總數(shù)以及已用IP總數(shù),以及網絡下每一個子網的IP地址總數(shù)和已用IP地址總數(shù)。

  • 系統(tǒng)預留地址指的是子網的第1個以及最后2個地址,一般用于網關、DHCP等服務。
  • 這里以及下文描述的IP地址總數(shù)、已用IP地址總數(shù)不包含系統(tǒng)預留地址。
  • 在分配IP時,用戶可以指定系統(tǒng)預留的IP地址。但是不論IP是如何分配的,只要是處于系統(tǒng)預留IP地址段的IP均不會被統(tǒng)計到已用IP地址數(shù)目和IP地址總數(shù)中。

調試

您可以在API Explorer中調試該接口。

URI

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

參數(shù)說明請參見表1。
表1 參數(shù)說明

參數(shù)名稱

類型

必選

說明

network_id

String

網絡的ID

說明:

network_id指調用VPC子網接口時,使用的子網ID。

更多信息請參見VPC子網接口與OpenStack Neutron子網接口的區(qū)別是什么?。

請求參數(shù)

請求示例

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

響應參數(shù)

表2 響應參數(shù)

名稱

參數(shù)類型

說明

network_ip_availability

network_ip_availability object

network_ip_avalability對象,請參見表3。

表3 network_ip_availability對象

名稱

參數(shù)類型

說明

network_id

String

網絡ID

network_name

String

網絡名稱

tenant_id

String

項目ID

total_ips

Integer

網絡中IP總數(shù)(不包含系統(tǒng)預留地址)

used_ips

Integer

網絡中已經使用的IP數(shù)目(不包含系統(tǒng)預留地址)

subnet_ip_availability

Array of subnet_ip_availability objects

子網IP使用情況的對象,參見表4。

表4 subnet_ip_availability對象說明

參數(shù)名稱

參數(shù)類型

說明

used_ips

Integer

子網中已經使用的IP數(shù)目(不包含系統(tǒng)預留地址)

subnet_id

String

子網ID

如果您使用管理控制臺,此值即為子網詳情中的“網絡ID”參數(shù)值。

subnet_name

String

子網名稱

ip_version

Integer

子網的IP版本,只支持Iv4

cidr

String

子網的CIDR

total_ips

Integer

子網中IP總數(shù)(不包含系統(tǒng)預留地址)

響應示例

{
  "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"
  }
}

狀態(tài)碼

請參見狀態(tài)碼。

錯誤碼

請參考錯誤碼