• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V3 Interfaces
  5. Volume transfer
  6. Create volume transfer

Create volume transfer

Function Description

This interface is used to create a volume transfer.

Interface Format

Method

URI

Description

POST

/v3/{project_id}/os-volume-transfer

Creates a volume transfer.

Restrictions

This interface cannot be used to create a transfer for the following types of volumes:

  • Volumes charged by period
  • Encrypted volumes
  • Volumes with backups and snapshots available.
  • Frozen volumes
  • Distributed Storage Service (DSS)/Distributed Enterprise Storage Service (DESS) volumes
  • System volumes
  • HyperMetro volumes
  • Volumes with backup policies configured

Extension Description

N/A

Request Parameter

Parameter

Type

Mandatory

Remarks

volume_id

String

Yes

Specifies the ID of the volume which is used to create a transfer.

name

String

No

Indicates the transfer name.

Response Parameter

Parameter

Type

Mandatory

Remarks

auth_key

String

Yes

Specifies the transfer authentication key.

links

List< Dict >

Yes

Specifies the link of the volume transfer.

created_at

String

Yes

Indicates the time when the transfer is created.

volume_id

String

Yes

Specifies the volume ID.

id

String

Yes

Specifies the transfer ID.

name

String

Yes

Indicates the transfer name.

Request Example

POST https://volume.localdomain.com:8776/v3/5dd0b0056f3d47b6ab4121667d35621a/os-volume-transfer
{
    "transfer": {
        "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
        "name": "first volume"
    }
}

Response Example

{
    "transfer": {
        "id": "1a7059f5-8ed7-45b7-8d05-2811e5d09f24",
        "created_at": "2015-02-25T03:56:53.081642",
        "name": "first volume",
        "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
        "auth_key": "9266c59563c84664",
        "links": [
            {
                "href": "http://localhost/v2/firstproject/volumes/3",
                "rel": "self"
            },
            {
                "href": "http://localhost/firstproject/volumes/3",
                "rel": "bookmark"
            }
        ]
    }
}

Error Code

See section Processing Return Code.