EMC ViPR REST API

Search (SHIFT+S)

API Reference


Modified since last release

Get Full Copy Progress Check

POST /block/volumes/{id}/protection/full-copies/{pid}/check-progress
This call has been deprecated and will be removed in future versions

Show synchronization progress for a full copy.

This method is deprecated. Use /block/full-copies/{id}/check-progress instead with {id} representing full copy URI id

idthe URN of a ViPR Source volume
pidFull copy URI

Required Roles

This call has no restrictions.


Request Payload

No Request Payload


Response Body

VolumeRestRep

Field Description Type Notes
<volume>
<allocated_capacity_gb> The total amount of space allocated from the volume's storage pool (GB) String
<pre_allocation_size_gb> The amount of space that was initially allocated when the volume was created (GB) String
<auto_tier_policy>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</auto_tier_policy>      
<requested_capacity_gb> This volume's total capacity in Gb (Gigabytes). String
<vpool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vpool>      
<is_composite> Specifies whether this is a composite (meta) volume. Boolean
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<provisioned_capacity_gb> This volume's logical capacity in Gb (Gigabytes). String
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<thinly_provisioned> Whether or not this volume is thinly provisioned. A thin volume initially allocates a portion of its assigned capacity when it is created and then grows as needed. Boolean
<high_availability_backing_volumes>
<high_availability_backing_volume>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</high_availability_backing_volume>      
</high_availability_backing_volumes>
<protection>    
<mirrors>    
<native_mirrors>
<native_mirror>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</native_mirror>      
</native_mirrors>
</mirrors>      
<recoverpoint>    
<targets> This volume's RecoverPoint (RP) target copies
<target>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</target>      
</targets>
<protection_set>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</protection_set>      
<protection_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</protection_system>      
<site_name> A label that can be used to denote the physical location of the volume String
<copy_name> The volume's RecoverPoint (RP) copy name. In this context, a production volume is a copy that is used as a source for replication. String
<replicationset_name> The name of this volume's RecoverPoint (RP) replication set. A replication set consists of a production volume and that volume's target copies. String
<personality> How this volume is used with respect to replication Valid values: SOURCE = A production volume TARGET = A copy of a production volume METADATA = A volume that stores meta-data for replication. Example: A RecoverPoint journal volume String
</recoverpoint>      
<full_copies>    
<associated_source_volume>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_source_volume>      
<volumes>
<volume>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume>      
</volumes>
<is_sync_active> Boolean
<percent_synced> Integer
<replicaState> String
<full_copy_set_name> the name to identify full copies created as a Set String
</full_copies>      
<srdf>    
<associated_source_volume>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_source_volume>      
<volumes>
<volume>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume>      
</volumes>
<personality> How this volume is used with respect to replication Valid values: SOURCE = A production volume TARGET = A copy of a production volume METADATA = A volume that stores meta-data for replication. Example = Recoverpoint journal volume String
<srdf_group_uri> URI
<srdf_copy_mode> String
</srdf>      
</protection>      
<access_state> The volume's access state String
<link_status> The volume's link status String
<has_xio_3x_backend_volumes> Specifies whether this is Xtremio 3.x volume or not. Boolean
<storage_pool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
<volume_groups>
<volume_group>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume_group>      
</volume_groups>
<supports_snapshot_sessions> Specifies whether this is volume supports Snapshot Sessions. Boolean
<system_type> Storage system's type String
<compression_ratio> String
<device_label> Label assigned to the Block object. An example of a block object is a volume. String
<native_id> Native ID for this Block object. String
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<protocols>
<protocol> String 0-* Elements
</protocols>
<storage_controller> Storage controller where this Block object is located. URI
<wwn> World Wide name of this Block object. String
<consistency_group>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</consistency_group>      
<replication_group_instance> Name reference of replication group that the object belong to. String
<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
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<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
<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
</volume>

Examples

Request
POST https://localhost:4443/block/volumes/urn:storageos:Volume:f85fb21a-ffc2-4fb4-9868-3b7fcc8c0bcf:/protection/full-copies/urn:storageos:Volume:c6324360-637e-4e28-94db-b268b6cdd4f2:/check-progress HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<volume>
   <allocated_capacity_gb>0.00</allocated_capacity_gb>
   <creation_time>1380815614151</creation_time>
   <device_label>fullcopyinactive</device_label>
   <id>urn:storageos:Volume:c6324360-637e-4e28-94db-b268b6cdd4f2:</id>
   <inactive>false</inactive>
   <is_composite>false</is_composite>
   <link>
      <href>/block/volumes/urn:storageos:Volume:c6324360-637e-4e28-94db-b268b6cdd4f2:</href>
      <rel>self</rel>
   </link>
   <name>full_copy_inactive</name>
   <native_id>010E2</native_id>
   <pre_allocation_size_gb>0.00</pre_allocation_size_gb>
   <project>
      <id>urn:storageos:Project:803835c6-27cd-417b-b888-64cd85e2f2a8:</id>
      <link>
         <href>/projects/urn:storageos:Project:803835c6-27cd-417b-b888-64cd85e2f2a8:</href>
         <rel>self</rel>
      </link>
   </project>
   <protection>
      <full_copies>
         <associated_source_volume>
            <id>urn:storageos:Volume:f85fb21a-ffc2-4fb4-9868-3b7fcc8c0bcf:</id>
            <link>
               <href>/block/volumes/urn:storageos:Volume:f85fb21a-ffc2-4fb4-9868-3b7fcc8c0bcf:</href>
               <rel>self</rel>
            </link>
         </associated_source_volume>
         <is_sync_active>true</is_sync_active>
         <percent_synced>100</percent_synced>
      </full_copies>
   </protection>
   <protocols>
      <element>FC</element>
   </protocols>
   <provisioned_capacity_gb>1.00</provisioned_capacity_gb>
   <requested_capacity_gb>1.00</requested_capacity_gb>
   <storage_controller>urn:storageos:StorageSystem:81426202-3380-4dd0-8517-b71d335d3768:</storage_controller>
   <tags />
   <tenant>
      <id>urn:storageos:TenantOrg:e2567a6d-e307-4acd-84ae-2e413fdec9a4:</id>
      <link>
         <href>/tenants/urn:storageos:TenantOrg:e2567a6d-e307-4acd-84ae-2e413fdec9a4:</href>
         <rel>self</rel>
      </link>
   </tenant>
   <thinly_provisioned>true</thinly_provisioned>
   <varray>
      <id>urn:storageos:VirtualArray:e428d5d6-bab0-4708-a63b-bbf79d45c86b:</id>
      <link>
         <href>/vdc/varrays/urn:storageos:VirtualArray:e428d5d6-bab0-4708-a63b-bbf79d45c86b:</href>
         <rel>self</rel>
      </link>
   </varray>
   <vpool>
      <id>urn:storageos:VirtualPool:b28bc64e-969a-43fe-8cd2-37b8ce49cb9f:</id>
      <link>
         <href>/block/vpools/urn:storageos:VirtualPool:b28bc64e-969a-43fe-8cd2-37b8ce49cb9f:</href>
         <rel>self</rel>
      </link>
   </vpool>
   <wwn>60000970000198700406533031304532</wwn>
</volume>