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
|
.. -*- rst -*-
.. needs:body_verification
=========================================
Server migrations (servers, migrations)
=========================================
List, show, perform actions on and delete server migrations.
List Migrations
===============
.. rest_method:: GET /servers/{server_id}/migrations
Lists in-progress live migrations for a given server.
.. note:: Microversion 2.23 or greater is required for this API.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
Response
--------
.. rest_parameters:: parameters.yaml
- migrations: migrations
- created_at: created
- dest_compute: migrate_dest_compute
- dest_host: migrate_dest_host
- dest_node: migrate_dest_node
- disk_processed_bytes: migrate_disk_processed_bytes
- disk_remaining_bytes: migrate_disk_remaining_bytes
- disk_total_bytes: migrate_disk_total_bytes
- id: migration_id
- memory_processed_bytes: migrate_memory_processed_bytes
- memory_remaining_bytes: migrate_memory_remaining_bytes
- memory_total_bytes: migrate_memory_total_bytes
- server_uuid: server_id
- source_compute: migrate_source_compute
- source_node: migrate_source_node
- status: migrate_status
- updated_at: updated
**Example List Migrations**
.. literalinclude:: ../../doc/api_samples/server-migrations/v2.23/migrations-index.json
:language: javascript
Show Migration Details
======================
.. rest_method:: GET /servers/{server_id}/migrations/{migration_id}
Show details for an in-progress live migration for a given server.
.. note:: Microversion 2.23 or greater is required for this API.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- migration_id: migration_id_path
Response
--------
.. rest_parameters:: parameters.yaml
- migration: migration
- created_at: created
- dest_compute: migrate_dest_compute
- dest_host: migrate_dest_host
- dest_node: migrate_dest_node
- disk_processed_bytes: migrate_disk_processed_bytes
- disk_remaining_bytes: migrate_disk_remaining_bytes
- disk_total_bytes: migrate_disk_total_bytes
- id: migration_id
- memory_processed_bytes: migrate_memory_processed_bytes
- memory_remaining_bytes: migrate_memory_remaining_bytes
- memory_total_bytes: migrate_memory_total_bytes
- server_uuid: server_id
- source_compute: migrate_source_compute
- source_node: migrate_source_node
- status: migrate_status
- updated_at: updated
**Example Show Migration Details**
.. literalinclude:: ../../doc/api_samples/server-migrations/v2.23/migrations-get.json
:language: javascript
Force Migration Complete Action (force_complete Action)
=======================================================
.. rest_method:: POST /servers/{server_id}/migrations/{migration_id}/action
Force an in-progress live migration for a given server to complete.
Specify the ``force_complete`` action in the request body.
.. note:: Microversion 2.22 or greater is required for this API.
.. note:: Not all compute back ends support forcefully completing an
in-progress live migration.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
**Preconditions**
The server OS-EXT-STS:vm_state value must be ``active`` and the server
OS-EXT-STS:task_state value must be ``migrating``.
If the server is locked, you must have administrator privileges to force the
completion of the server migration.
The migration status must be ``running``.
**Asynchronous Postconditions**
After you make this request, you typically must keep polling the server status
to determine whether the request succeeded.
**Troubleshooting**
If the server status remains ``ACTIVE`` for an inordinate amount of time, the
request may have failed. Ensure you meet the preconditions and run the request
again. If the request fails again, investigate the compute back end.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- migration_id: migration_id_path
- force_complete: force_migration_complete
**Example Force Migration Complete (force_complete Action)**
.. literalinclude:: ../../doc/api_samples/server-migrations/force_complete.json
:language: javascript
Response
--------
There is no body content for the response of a successful POST operation.
Delete (Abort) Migration
========================
.. rest_method:: DELETE /servers/{server_id}/migrations/{migration_id}
Request
-------
.. rest_parameters:: parameters.yaml
- server_id: server_id_path
- migration_id: migration_id_path
Response
--------
There is no body content for the response of a successful DELETE operation.
|
