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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
.. -*- rst -*-
====================================
Subnet pools extension (subnetpools)
====================================
Lists, creates, shows details for, updates, and deletes subnet
pools.
Address Scopes Extension
========================
The ``address-scope`` extension adds the ``address_scope_id`` attribute to
subnet pools. ``address_scope_id`` is the ID of the address scope that the
subnet pool belongs to.
Resource timestamps
===================
The ``standard-attr-timestamp`` extension adds the ``created_at`` and
``updated_at`` attributes to all resources that have standard attributes.
Tag extension
=============
The ``standard-attr-tag`` adds Tag support for resources with
standard attributes by adding the ``tags`` attribute
allowing consumers to associate tags with resources.
Show subnet pool
================
.. rest_method:: GET /v2.0/subnetpools/{subnetpool_id}
Shows information for a subnet pool.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- subnetpool_id: subnetpool_id
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- subnetpool: subnetpool
- id: subnetpool_id_body
- name: name
- default_quota: default_quota
- tenant_id: project_id
- project_id: project_id
- created_at: created_at_resource
- updated_at: updated_at_resource
- prefixes: prefixes
- min_prefixlen: min_prefixlen
- address_scope_id: address_scope_id
- ip_version: ip_version
- shared: shared
- default_prefixlen: default_prefixlen
- max_prefixlen: max_prefixlen
- description: description
- is_default: subnetpool_is_default
- revision_number: revision_number
- tags: tags
Response Example
----------------
.. literalinclude:: samples/subnets/subnetpool-show-response.json
:language: javascript
Update subnet pool
==================
.. rest_method:: PUT /v2.0/subnetpools/{subnetpool_id}
Updates a subnet pool.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- subnetpool_id: subnetpool_id
- subnetpool: subnetpool
- name: name
- default_quota: default_quota
- tenant_id: project_id
- project_id: project_id
- prefixes: prefixes
- min_prefixlen: min_prefixlen
- address_scope_id: address_scope_id
- default_prefixlen: default_prefixlen
- max_prefixlen: max_prefixlen
- description: description-request
- is_default: subnetpool_is_default-request
Request Example
---------------
.. literalinclude:: samples/subnets/subnetpool-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- subnetpool: subnetpool
- id: subnetpool_id_body
- name: name
- default_quota: default_quota
- tenant_id: project_id
- project_id: project_id
- created_at: created_at_resource
- updated_at: updated_at_resource
- prefixes: prefixes
- min_prefixlen: min_prefixlen
- address_scope_id: address_scope_id
- ip_version: ip_version
- shared: shared
- default_prefixlen: default_prefixlen
- max_prefixlen: max_prefixlen
- description: description
- is_default: subnetpool_is_default
- revision_number: revision_number
- tags: tags
Response Example
----------------
.. literalinclude:: samples/subnets/subnetpool-update-response.json
:language: javascript
Delete subnet pool
==================
.. rest_method:: DELETE /v2.0/subnetpools/{subnetpool_id}
Deletes a subnet pool.
The operation fails if any subnets allocated from the subnet pool
are still in use.
Normal response codes: 204
Error response codes: 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- subnetpool_id: subnetpool_id
Response
--------
There is no body content for the response of a successful DELETE request.
List subnet pools
=================
.. rest_method:: GET /v2.0/subnetpools
Lists subnet pools that the project has access to.
Default policy settings return only the subnet pools owned by
the project of the user submitting the request, unless the
user has administrative role.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- name: name-query
- default_quota: default_quota-query
- tenant_id: project_id-query
- project_id: project_id-query
- min_prefixlen: min_prefixlen-query
- address_scope_id: address_scope_id-query
- ip_version: ip_version-query
- shared: shared-query
- default_prefixlen: default_prefixlen-query
- max_prefixlen: max_prefixlen-query
- description: description-query
- is_default: subnetpool_is_default-query
- revision_number: revision_number-query
- sort_dir: sort_dir
- sort_key: subnetpool-sort_key
- tags: tags-query
- tags-any: tags-any-query
- not-tags: not-tags-query
- not-tags-any: not-tags-any-query
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- subnetpools: subnetpools
- id: subnetpool_id_body
- name: name
- default_quota: default_quota
- tenant_id: project_id
- project_id: project_id
- created_at: created_at_resource
- updated_at: updated_at_resource
- prefixes: prefixes
- min_prefixlen: min_prefixlen
- address_scope_id: address_scope_id
- ip_version: ip_version
- shared: shared
- default_prefixlen: default_prefixlen
- max_prefixlen: max_prefixlen
- description: description
- is_default: subnetpool_is_default
- revision_number: revision_number
- tags: tags
Response Example
----------------
.. literalinclude:: samples/subnets/subnetpools-list-response.json
:language: javascript
Create subnet pool
==================
.. rest_method:: POST /v2.0/subnetpools
Creates a subnet pool.
Normal response codes: 201
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- subnetpool: subnetpool
- name: name
- default_quota: default_quota
- tenant_id: project_id
- project_id: project_id
- prefixes: prefixes
- min_prefixlen: min_prefixlen
- address_scope_id: address_scope_id
- shared: shared
- default_prefixlen: default_prefixlen
- max_prefixlen: max_prefixlen
- description: description-request
- is_default: subnetpool_is_default
Request Example
---------------
.. literalinclude:: samples/subnets/subnetpool-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- subnetpool: subnetpool
- id: subnetpool_id_body
- name: name
- default_quota: default_quota
- tenant_id: project_id
- project_id: project_id
- created_at: created_at_resource
- updated_at: updated_at_resource
- prefixes: prefixes
- min_prefixlen: min_prefixlen
- address_scope_id: address_scope_id
- ip_version: ip_version
- shared: shared
- default_prefixlen: default_prefixlen
- max_prefixlen: max_prefixlen
- description: description
- is_default: subnetpool_is_default
- revision_number: revision_number
- tags: tags
Response Example
----------------
.. literalinclude:: samples/subnets/subnetpool-create-response.json
:language: javascript
|
