1.. -*- rst -*-
2
3Volume transfer
4===============
5
6Transfers a volume from one user to another user.
7
8
9Accept volume transfer
10~~~~~~~~~~~~~~~~~~~~~~
11
12.. rest_method::  POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept
13
14Accepts a volume transfer.
15
16Normal response codes: 202
17
18
19Request
20-------
21
22.. rest_parameters:: parameters.yaml
23
24   - auth_key: auth_key
25   - transfer_id: transfer_id
26   - project_id: project_id_path
27
28Request Example
29---------------
30
31.. literalinclude:: ./samples/volume-transfer-accept-request.json
32   :language: javascript
33
34Response Parameters
35-------------------
36
37.. rest_parameters:: parameters.yaml
38
39   - volume_id: volume_id
40   - id: id
41   - links: links
42   - name: name
43
44Response Example
45----------------
46
47.. literalinclude:: ./samples/volume-transfer-accept-response.json
48   :language: javascript
49
50
51Create volume transfer
52~~~~~~~~~~~~~~~~~~~~~~
53
54.. rest_method::  POST /v2/{project_id}/os-volume-transfer
55
56Creates a volume transfer.
57
58Normal response codes: 202
59
60
61Request
62-------
63
64.. rest_parameters:: parameters.yaml
65
66   - name: name
67   - volume_id: volume_id
68   - project_id: project_id_path
69
70Request Example
71---------------
72
73.. literalinclude:: ./samples/volume-transfer-create-request.json
74   :language: javascript
75
76
77Response Parameters
78-------------------
79
80.. rest_parameters:: parameters.yaml
81
82   - auth_key: auth_key
83   - links: links
84   - created_at: created_at
85   - volume_id: volume_id
86   - id: id
87   - name: name
88
89Response Example
90----------------
91
92.. literalinclude:: ./samples/volume-transfer-create-response.json
93   :language: javascript
94
95
96List volume transfers
97~~~~~~~~~~~~~~~~~~~~~
98
99.. rest_method::  GET /v2/{project_id}/os-volume-transfer
100
101Lists volume transfers.
102
103
104Normal response codes: 200
105
106
107Request
108-------
109
110.. rest_parameters:: parameters.yaml
111
112   - project_id: project_id_path
113   - all_tenants: all-tenants
114
115
116Response Parameters
117-------------------
118
119.. rest_parameters:: parameters.yaml
120
121   - volume_id: volume_id
122   - id: id
123   - links: links
124   - name: name
125
126
127Response Example
128----------------
129
130.. literalinclude:: ./samples/volume-transfers-list-response.json
131   :language: javascript
132
133
134Show volume transfer details
135~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136
137.. rest_method::  GET /v2/{project_id}/os-volume-transfer/{transfer_id}
138
139Shows details for a volume transfer.
140
141
142Normal response codes: 200
143
144
145Request
146-------
147
148.. rest_parameters:: parameters.yaml
149
150   - transfer_id: transfer_id
151   - project_id: project_id_path
152
153
154Response Parameters
155-------------------
156
157.. rest_parameters:: parameters.yaml
158
159   - created_at: created_at
160   - volume_id: volume_id
161   - id: id
162   - links: links
163   - name: name
164
165
166Response Example
167----------------
168
169.. literalinclude:: ./samples/volume-transfer-show-response.json
170   :language: javascript
171
172
173Delete volume transfer
174~~~~~~~~~~~~~~~~~~~~~~
175
176.. rest_method::  DELETE /v2/{project_id}/os-volume-transfer/{transfer_id}
177
178Deletes a volume transfer.
179
180Normal response codes: 202
181
182
183Request
184-------
185
186.. rest_parameters:: parameters.yaml
187
188   - transfer_id: transfer_id
189   - project_id: project_id_path
190
191
192List volume transfers, with details
193~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194
195.. rest_method::  GET /v2/{project_id}/os-volume-transfer/detail
196
197Lists volume transfers, with details.
198
199
200Normal response codes: 200
201
202Request
203-------
204
205.. rest_parameters:: parameters.yaml
206
207   - project_id: project_id_path
208   - all_tenants: all-tenants
209
210Response Parameters
211-------------------
212
213.. rest_parameters:: parameters.yaml
214
215   - created_at: created_at
216   - volume_id: volume_id
217   - id: id
218   - links: links
219   - name: name
220
221Response Example
222----------------
223
224.. literalinclude:: ./samples/volume-transfers-list-detailed-response.json
225   :language: javascript
226