1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
.. -*- rst -*-
=======================================
Network IP availability and usage stats
=======================================
The extension ``network-ip-availability`` allows users to list and show the
network IP usage stats of all networks or of a specified network.
By default policy configuration, only administrative users can use this API.
Show Network IP Availability
============================
.. rest_method:: GET /v2.0/network-ip-availabilities/{network_id}
Shows network IP availability details for a network.
By default policy configuration, only administrative users can retrieve
IP availability. Otherwise, ``Not Found (404)`` will be returned.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- network_id: network_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- network_ip_availability: network_ip_availability
- network_id: network_ip_availability-network_id
- network_name: network-name
- tenant_id: project_id
- project_id: project_id
- total_ips: total_ips
- used_ips: used_ips
- subnet_ip_availability: subnet_ip_availability
- subnet_id: network_ip_availability-subnet_id
- subnet_name: subnet_name
- ip_version: subnet-ip_version
- cidr: cidr
Response Example
----------------
.. literalinclude:: samples/network-ip-availability/network-ip-availability-show.json
:language: javascript
List Network IP Availability
============================
.. rest_method:: GET /v2.0/network-ip-availabilities
Lists network IP availability of all networks.
By default policy configuration, only administrative users can retrieve
IP availabilities. Otherwise, an empty list will be returned.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- network_id: network_ip_availability-network_id-query
- network_name: network-name-query
- tenant_id: project_id-query
- project_id: project_id-query
- ip_version: ip_version-query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- network_ip_availabilities: network_ip_availabilities
- network_id: network_ip_availability-network_id
- network_name: network-name
- tenant_id: project_id
- project_id: project_id
- total_ips: total_ips
- used_ips: used_ips
- subnet_ip_availability: subnet_ip_availability
- subnet_id: network_ip_availability-subnet_id
- subnet_name: subnet_name
- ip_version: subnet-ip_version
- cidr: cidr
Response Example
----------------
.. literalinclude:: samples/network-ip-availability/network-ip-availability-list.json
:language: javascript
|
