2016-09-17 01:12:40 -04:00
|
|
|
.. -*- rst -*-
|
|
|
|
|
|
|
|
Volume transfer
|
|
|
|
===============
|
|
|
|
|
|
|
|
Transfers a volume from one user to another user.
|
|
|
|
|
|
|
|
|
|
|
|
Accept a volume transfer
|
2017-02-02 15:56:50 -06:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-09-17 01:12:40 -04:00
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
.. rest_method:: POST /v3/{project_id}/os-volume-transfer/{transfer_id}/accept
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Accepts a volume transfer.
|
|
|
|
|
2017-03-14 10:18:04 +08:00
|
|
|
Normal response codes: 202
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- auth_key: auth_key
|
|
|
|
- transfer_id: transfer_id
|
2017-01-09 11:51:06 +08:00
|
|
|
- project_id: project_id_path
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Request Example
|
|
|
|
---------------
|
|
|
|
|
|
|
|
.. literalinclude:: ./samples/volume-transfer-accept-request.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response Parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- volume_id: volume_id
|
|
|
|
- id: id
|
|
|
|
- links: links
|
|
|
|
- name: name
|
|
|
|
|
|
|
|
|
|
|
|
Create a volume transfer
|
2017-02-02 15:56:50 -06:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-09-17 01:12:40 -04:00
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
.. rest_method:: POST /v3/{project_id}/os-volume-transfer
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Creates a volume transfer.
|
|
|
|
|
2017-03-14 10:18:04 +08:00
|
|
|
Normal response codes: 202
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- name: name
|
|
|
|
- volume_id: volume_id
|
2017-01-09 11:51:06 +08:00
|
|
|
- project_id: project_id_path
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Request Example
|
|
|
|
---------------
|
|
|
|
|
|
|
|
.. literalinclude:: ./samples/volume-transfer-create-request.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Response Parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- auth_key: auth_key
|
|
|
|
- links: links
|
|
|
|
- created_at: created_at
|
|
|
|
- volume_id: volume_id
|
|
|
|
- id: id
|
|
|
|
- name: name
|
|
|
|
|
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
List volume transfers for a project
|
2017-02-02 15:56:50 -06:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-09-17 01:12:40 -04:00
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
.. rest_method:: GET /v3/{project_id}/os-volume-transfer
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Lists volume transfers.
|
|
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes:
|
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
- project_id: project_id_path
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
Response Parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- volume_id: volume_id
|
|
|
|
- id: id
|
|
|
|
- links: links
|
|
|
|
- name: name
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: ./samples/volume-transfers-list-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Show volume transfer detail
|
2017-02-02 15:56:50 -06:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-09-17 01:12:40 -04:00
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
.. rest_method:: GET /v3/{project_id}/os-volume-transfer/{transfer_id}
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Shows details for a volume transfer.
|
|
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes:
|
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- transfer_id: transfer_id
|
2017-01-09 11:51:06 +08:00
|
|
|
- project_id: project_id_path
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
Response Parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- created_at: created_at
|
|
|
|
- volume_id: volume_id
|
|
|
|
- id: id
|
|
|
|
- links: links
|
|
|
|
- name: name
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: ./samples/volume-transfer-show-response.json
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Delete a volume transfer
|
2017-02-02 15:56:50 -06:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-09-17 01:12:40 -04:00
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
.. rest_method:: DELETE /v3/{project_id}/os-volume-transfer/{transfer_id}
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Deletes a volume transfer.
|
|
|
|
|
2017-03-14 10:18:04 +08:00
|
|
|
Normal response codes: 202
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- transfer_id: transfer_id
|
2017-01-09 11:51:06 +08:00
|
|
|
- project_id: project_id_path
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
List volume transfers and details
|
2017-02-02 15:56:50 -06:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-09-17 01:12:40 -04:00
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
.. rest_method:: GET /v3/{project_id}/os-volume-transfer/detail
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Lists volume transfers, with details.
|
|
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes:
|
|
|
|
|
|
|
|
Request
|
|
|
|
-------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2017-01-09 11:51:06 +08:00
|
|
|
- project_id: project_id_path
|
2016-09-17 01:12:40 -04:00
|
|
|
|
|
|
|
Response Parameters
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
- created_at: created_at
|
|
|
|
- volume_id: volume_id
|
|
|
|
- id: id
|
|
|
|
- links: links
|
|
|
|
- name: name
|
|
|
|
|
|
|
|
Response Example
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. literalinclude:: ./samples/volume-transfers-list-detailed-response.json
|
|
|
|
:language: javascript
|