blob: 3b13e18033d3e2c1ac0d69cb63c2837d1ec7eea3 (
plain)
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
|
============
Zone Exports
============
Zone exports can be an asynchronous operation,
and there are different endpoints to view the status and progress of an export
Create a Zone Export
====================
.. rest_method:: POST /v2/zones/{zone_id}/tasks/export
Export a zone.
.. note:: This POST should have no body
.. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 409
- 503
Request
-------
.. rest_parameters:: parameters.yaml
- x-auth-token: x-auth-token
- x-auth-all-projects: x-auth-all-projects
- x-auth-sudo-project-id: x-auth-sudo-project-id
- zone_id: path_zone_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- x-openstack-request-id: x-openstack-request-id
- id: zone_export_id
- location: zone_export_location
- status: zone_export_status
- zone_id: zone_export_zone_id
- message: zone_export_message
- project_id: project_id
- created_at: created_at
- updated_at: updated_at
- version: version
Response Example
----------------
.. literalinclude:: samples/zones/create-zone-export-response.json
:language: javascript
List all Zone Exports
=====================
.. rest_method:: GET /v2/zones/tasks/exports
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request
-------
.. rest_parameters:: parameters.yaml
- x-auth-token: x-auth-token
- x-auth-all-projects: x-auth-all-projects
- x-auth-sudo-project-id: x-auth-sudo-project-id
- zone_id: zone_export_zone_id_filter
- message: zone_export_message_filter
- status: zone_export_status_filter
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- x-openstack-request-id: x-openstack-request-id
- id: zone_export_id
- location: zone_export_location
- status: zone_export_status
- zone_id: zone_export_zone_id
- project_id: project_id
- created_at: created_at
- updated_at: updated_at
- version: version
- links: links
- metadata: metadata
Response Example
----------------
.. literalinclude:: samples/zones/list-zone-export-response.json
:language: javascript
Show a Zone Export Information
==============================
.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request
-------
.. rest_parameters:: parameters.yaml
- x-auth-token: x-auth-token
- x-auth-all-projects: x-auth-all-projects
- x-auth-sudo-project-id: x-auth-sudo-project-id
- zone_export_id: path_zone_export_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- x-openstack-request-id: x-openstack-request-id
- id: zone_export_id
- location: zone_export_location
- status: zone_export_status
- zone_id: zone_export_zone_id
- project_id: project_id
- created_at: created_at
- updated_at: updated_at
- version: version
- links: links
Response Example
----------------
.. literalinclude:: samples/zones/show-zone-export-response.json
:language: javascript
Retrive a Zone Export from the Designate Datastore
==================================================
.. rest_method:: GET /v2/zones/tasks/exports/{zone_export_id}/export
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
.. note::
This endpoint will send a response with a ``text/dns`` content-type.
If the client does not include a ``Accepts: text/dns`` header the request
will be rejected.
Request
-------
.. rest_parameters:: parameters.yaml
- x-auth-token: x-auth-token
- x-auth-all-projects: x-auth-all-projects
- x-auth-sudo-project-id: x-auth-sudo-project-id
- zone_export_id: path_zone_export_id
- accepts: zone_export_accepts
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- x-openstack-request-id: x-openstack-request-id
Response Example
----------------
.. literalinclude:: samples/zones/show-zone-export-content.txt
:language: text
Delete a Zone Export
====================
.. rest_method:: DELETE /v2/zones/tasks/exports/{zone_export_id}
This will just delete the record of the zone export, not the exported zone.
The zone will have to be deleted from the zone delete API
.. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 405
- 503
Request
-------
.. rest_parameters:: parameters.yaml
- x-auth-token: x-auth-token
- x-auth-all-projects: x-auth-all-projects
- x-auth-sudo-project-id: x-auth-sudo-project-id
- zone_export_id: path_zone_export_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- x-openstack-request-id: x-openstack-request-id
|
