Creating a Disk Transfer¶

Function¶

This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.

After a disk transfer is created, the disk status changes from available to awaiting-transfer. Once the disk transfer is accepted, the disk status changes to available again.

Constraints¶

A disk transfer can be created only when the disk status is available. The detailed constraints are as follows:

Encrypted EVS disks cannot be transferred.
EVS disks with backups and snapshots available cannot be transferred.
EVS disks associated with backup policies cannot be transferred.
EVS disks used as system disks cannot be transferred.

Note

If the disk transfer is created using one of the unsupported disks, error code 400 will be returned.

URI¶

URI format
POST /v2/{project_id}/os-volume-transfer
Parameter description
Parameter
Mandatory
Description
project_id
Yes
The project ID.
For details about how to obtain the project ID, see Obtaining a Project ID.

Parameter	Mandatory	Description
project_id	Yes	The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request¶

Request parameters
Parameter
Type
Mandatory
Description
transfer
Object
Yes
The transfer creation marker. For details, see Parameters in the transfer field.
Parameters in the transfer field
Parameter
Type
Mandatory
Description
volume_id
String
Yes
The disk ID.
name
String
Yes
The transfer name, which can contain a maximum of 255 bytes.

Parameter	Type	Mandatory	Description
transfer	Object	Yes	The transfer creation marker. For details, see Parameters in the transfer field.

Parameter	Type	Mandatory	Description
volume_id	String	Yes	The disk ID.
name	String	Yes	The transfer name, which can contain a maximum of 255 bytes.

Example request

{
    "transfer": {
        "volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
        "name": "first volume"
    }
}

Response¶

Response parameters
Parameter
Type
Description
transfer
Object
The transfer information. For details, see Parameters in the transfer field.

Parameter	Type	Description
transfer	Object	The transfer information. For details, see Parameters in the transfer field.

Parameters in the transfer field

Parameter	Type	Description
auth_key	String	The authentication key of the transfer.
links	Array of Objects	The links of the transfer. See Parameters in the links field.
created_at	String	The time when the transfer was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
volume_id	String	The disk ID.
id	String	The transfer ID.
name	String	The transfer name.

Parameters in the links field
Parameter
Type
Description
href
String
The corresponding shortcut link.
rel
String
The shortcut link marker name.
The default value is next.

Parameter	Type	Description
href	String	The corresponding shortcut link.
rel	String	The shortcut link marker name. The default value is next.

Example response

{
    "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": "https://localhost/v2/firstproject/os-volume-transfer/3",
                "rel": "self"
            },
            {
                "href": "https://localhost/firstproject/os-volume-transfer/3",
                "rel": "bookmark"
            }
        ]
    }
}

Status Codes¶

Normal
202

Error Codes¶

For details, see Error Codes.

last updated: 2024-11-08 14:12 UTC - commit: 50da2676988856820379788ad5f4675a0a4e9b06