a7dde84ba1
verify the parameters of os-migrations.inc including response and request. And, add warning for deprecation and incorrect wording of policy default rule. looks like the new migration is missing in doc, follow up patch will add it. Part of bp:api-ref-in-rst Change-Id: I8fed7374c34c5c857c8c55f56f86ad4c744844e9
48 lines
1.1 KiB
ReStructuredText
48 lines
1.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=========================================
|
|
Migrations (os-migrations) (frozen)
|
|
=========================================
|
|
|
|
Shows data on migrations.
|
|
|
|
.. warning:: The old top-level resource `/os-migrations` is frozen,
|
|
it won't be extended anymore. Use /servers/{uuid}/migrations instead.
|
|
|
|
List Migrations
|
|
===============
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-migrations
|
|
|
|
Lists in-progress migrations.
|
|
|
|
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
|
|
|
|
- tenant_id: tenant_id
|
|
- status: migration_status
|
|
- host: migration_host
|
|
- source_compute: migration_source_compute
|
|
- migration_type: migration_type
|
|
- hidden: migration_hidden
|
|
- instance_uuid: migration_instance_uuid
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Migrations: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-migrations/migrations-get.json
|
|
:language: javascript
|
|
|