Migration:Get Migration

Search (SHIFT+S)



Get Migration

GET /block/migrations/{id}

Returns the data for the migration with the id specified in the request.

idthe URN of a ViPR migration.

Required Roles

Requires one of the following roles:

  • TENANT_ADMIN
  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

A MigrationRestRep instance specifying the information about the migration.

Field Description Type Notes
<block_migration>
<percent_done> The percentage of the migration which has been completed. String Valid Values:
  •  0-100
<source>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</source>      
<start_time> The start time of the migration. String Valid Values:
  •  EEE MMM dd hh:mm:ss z yyyy
<status> The status of the migration. String Valid Values:
  •  in-progress = The migration is in progress.
  •  complete = The migration has completed.
  •  paused = The migration has been paused.
  •  cancelled = The migration has been canceled.
  •  committed = The migration has been committed.
  •  ready = The initial state for a migration after it has been created.
  •  error = The migration failed.
  •  partially-committed = The migration is in the process of being committed.
  •  partially-cancelled = The migration is in the process of being canceled.
  •  queued = The migration is queued and awaiting execution.
<target>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</target>      
<volume>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume>      
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</block_migration>
Notes: