REST API Reference Version 4.4.0.0Search

Move

POST v1/volumes/id/actions/move

Description

Move a volume and its related volumes to another pool. To change a single volume's folder assignment (while remaining in the same pool), use a volume update operation to change the folder_id attribute.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Request

Parameter Type JSON Type Description Mandatory
id NsObjectID string ID of the volume to move. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true
dest_pool_id NsObjectID string ID of the destination pool or folder. Specify a pool ID when the volumes should not be in a folder; otherwise, specify a folder ID and the pool will be derived from the folder. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true

JSON Request

            

{
    "data" : {
        "dest_pool_id" : "0a00000000000004d3000000000000000000000002"
    }
}

       
         

Response

Type: NsVolumeListReturn

Member Type JSON Type Description
vol_list NsVolumeList array A list of volume names and IDs. List of volumes.

JSON Response

            

{
    "data" : {
        "vol_list" : [
            {
                "id" : "0600000000000004d3000000000000000000000005",
                "vol_id" : "0600000000000004d3000000000000000000000005",
                "name" : "vol0.762157726640911"
                "vol_name" : "vol0.762157726640911"
            },
            {
                "id" : "0600000000000004d3000000000000000000000006",
                "vol_id" : "0600000000000004d3000000000000000000000006",
                "name" : "vol0.762157726640912"
                "vol_name" : "vol0.762157726640912"
            }
        ]
    }
}