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
|
.. -*- rst -*-
List Availability Zones
=======================
.. rest_method:: GET /v2.0/lbaas/availabilityzones
List all available availability zones.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see :ref:`filtering`.
The list might be empty.
**New in version 2.14**
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- fields: fields
Curl Example
------------
.. literalinclude:: examples/availabilityzone-list-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zones: availability-zones
- name: name
Response Example
----------------
.. literalinclude:: examples/availabilityzone-list-response.json
:language: javascript
Create Availability Zone
========================
.. rest_method:: POST /v2.0/lbaas/availabilityzones
Creates an availability zone.
If the API cannot fulfill the request due to insufficient data or
data that is not valid, the service returns the HTTP ``Bad Request
(400)`` response code with information about the failure in the
response body. Validation errors require that you correct the error
and submit the request again.
If you are not an administrative user the service returns the HTTP ``Forbidden
(403)`` response code.
**New in version 2.14**
.. rest_status_code:: success ../http-status.yaml
- 201
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- description: description-optional
- enabled: enabled-optional
- availability_zone: availability_zone
- availability_zone_profile_id: availability-zone-profile-id
- name: name
Request Example
---------------
.. literalinclude:: examples/availabilityzone-create-request.json
:language: javascript
Curl Example
------------
.. literalinclude:: examples/availabilityzone-create-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zone: availability_zone
- name: name
Response Example
----------------
.. literalinclude:: examples/availabilityzone-create-response.json
:language: javascript
Show Availability Zone Details
==============================
.. rest_method:: GET /v2.0/lbaas/availabilityzones/{availability_zone_name}
Shows the details of an availability zone.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see :ref:`filtering`.
This operation does not require a request body.
**New in version 2.14**
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 401
- 404
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- fields: fields
- availability_zone_name: path-availability-zone-name
Curl Example
------------
.. literalinclude:: examples/availabilityzone-show-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zone: availability_zone
- name: name
Response Example
----------------
.. literalinclude:: examples/availabilityzone-show-response.json
:language: javascript
Update an Availability Zone
===========================
.. rest_method:: PUT /v2.0/lbaas/availabilityzones/{availability_zone_name}
Update an availability zone.
If you are not an administrative user the service returns the HTTP ``Forbidden
(403)`` response code.
**New in version 2.14**
.. rest_status_code:: success ../http-status.yaml
- 200
.. rest_status_code:: error ../http-status.yaml
- 400
- 401
- 403
- 404
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- description: description-optional
- enabled: enabled-optional
- availability_zone: availability_zone
- availability_zone_name: path-availability-zone-name
Request Example
---------------
.. literalinclude:: examples/availabilityzone-update-request.json
:language: javascript
Curl Example
------------
.. literalinclude:: examples/availabilityzone-update-curl
:language: bash
Response Parameters
-------------------
.. rest_parameters:: ../parameters.yaml
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zone: availability_zone
- name: name
Response Example
----------------
.. literalinclude:: examples/availabilityzone-update-response.json
:language: javascript
Remove an Availability Zone
===========================
.. rest_method:: DELETE /v2.0/lbaas/availabilityzones/{availability_zone_name}
Remove an availability zone and its associated configuration.
If any load balancers are using this availability zone the service returns
the HTTP ``Conflict (409)`` response code.
If you are not an administrative user the service returns the HTTP ``Forbidden
(403)`` response code.
**New in version 2.14**
.. rest_status_code:: success ../http-status.yaml
- 204
.. rest_status_code:: error ../http-status.yaml
- 401
- 403
- 404
- 409
- 500
Request
-------
.. rest_parameters:: ../parameters.yaml
- availability_zone_name: path-availability-zone-name
Curl Example
------------
.. literalinclude:: examples/availabilityzone-delete-curl
:language: bash
Response
--------
There is no body content for the response of a successful DELETE request.
|
