Volume:Pause Continuous Copies

Search (SHIFT+S)

API Reference


Pause Continuous Copies

POST /block/volumes/{id}/protection/continuous-copies/pause

Pause continuous copies for given source volume NOTE: This is an asynchronous operation.

idthe URN of a ViPR Source volume

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<copies>
<copy>     0-* Elements
<sync> String
<type> Type of protection. String
<copyID> URI
<name> User provided name. String
<count> User provided number of copies. Integer
<syncDirection> User provided direction for the synchronization. Valid values SOURCE_TO_TARGET, TARGET_TO_SOURCE String
<copyMode> User provided SRDF copy mode for the synchronization. Valid values: SYNCHRONOUS = Change SRDf copy mode to SYNCHRONOUS ASYNCHRONOUS = Change SRDf copy mode to ASYNCHRONOUS ADAPTIVECOPY = Change SRDf copy mode to ADAPTIVECOPY String
<pointInTime> User provided any point-in-time for copy operations. Valid value: "yyyy-MM-dd_HH:mm:ss" formatted date or datetime in milliseconds. String
</copy>      
</copies>

Response Body

TaskList

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<tasks>
<task>     0-* Elements
<op_id> The task operation id String
<resource>    
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</resource>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<associated_resources> A list of links for associated resources
<associated_resource>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_resource>      
</associated_resources>
<state> The state of the task Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails String
<message> The task detail message String
<description> The description of the task String
<service_error>    
<code> The numerical code associated with the error encountered when processing a service request Integer
<description> The description of the error String
<details> Detailed information concerning the error String
</service_error>      
<start_time> The date and time of when the task was started DateTime
<end_time> The date and time of when the task ended DateTime
<progress> Integer
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<queuedStartTime> DateTime
<queueName> 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
</task>      
</tasks>

Examples

Request
POST https://localhost:4443/block/volumes/urn:storageos:Volume:f85fb21a-ffc2-4fb4-9868-3b7fcc8c0bcf:/protection/continuous-copies/pause HTTP/1.1

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <associated_resources>
      <element>
         <id>urn:storageos:BlockMirror:11c7bae2-60d5-469a-a9d1-e2358d6e6822:</id>
         <link>
            <href>/block/volumes/urn:storageos:Volume:f85fb21a-ffc2-4fb4-9868-3b7fcc8c0bcf:/protection/continuous-copies/urn:storageos:BlockMirror:11c7bae2-60d5-469a-a9d1-e2358d6e6822:</href>
            <rel>self</rel>
         </link>
         <name>mirror</name>
      </element>
   </associated_resources>
   <link>
      <href>/block/volumes/urn:storageos:Volume:f85fb21a-ffc2-4fb4-9868-3b7fcc8c0bcf:/tasks/9e5aab82-e9d1-4889-9988-a5a92babd811</href>
      <rel>self</rel>
   </link>
   <op_id>9e5aab82-e9d1-4889-9988-a5a92babd811</op_id>
   <resource>
      <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>
      <name>volume</name>
   </resource>
   <start_time>1380819274507</start_time>
   <state>pending</state>
</root>
Notes: