(POST) /cdpReplicas/{ID}/vms/{ID}?action=intervals

In this article

    Returns a collection of available intervals for the specified VM included in the specified CDP replica.

    Request

    To get a collection of available intervals for the specified VM, you need to send the POST HTTP request to the /cdpReplicas/{ID}/vms/{ID}?action=intervals URL.

    HTTP Request

    POST https://<Enterprise-Manager>:9398/api/cdpReplicas/{ID}/vms/{ID}?action=intervals

    Request Headers

    The request contains the following headers:

    Header

    Required

    Description

    X-RestSvcSessionId

    True

    The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

    Accept

    False

    Identifies the format of the response. Possible values:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    The request body must conform to the XML Schema Definition of Veeam Backup Enterprise Manager REST API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    StartDate

    DateTime

    The earliest start date and time for the returning intervals. The parameter accepts only UTC-formatted DateTime values.

    Yes

    1/1

    EndDate

    DateTime

    The latest end date and time for the returning intervals. The parameter accepts only UTC-formatted DateTime values.

    Yes

    1/1

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message. Possible values:

    • application/xml
    • application/json

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns a representation of the /cdpReplicaIntervals resource.

    Example

    The example below returns a collection of available intervals for the VM that has ID e809a086-2562-4a0f-a9a8-9c115ff8f0ba and that is included in the CDP replica with ID 7665222c-2e99-4a3f-b892-1827ba8d1eee.

    Request:

    POST https://localhost:9398/api/cdpReplicas/7665222c-2e99-4a3f-b892-1827ba8d1eee/vms/e809a086-2562-4a0f-a9a8-9c115ff8f0ba?action=intervals

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <CdpIntervalsSpec xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.veeam.com/ent/v1.0">
     <StartDate>2021-02-16T23:14:49.3577069Z</StartDate>
     <EndDate>2021-02-17T23:14:49.3577069Z</EndDate>
    </CdpIntervalsSpec>

     

    Response:

    200 OK

     

    Response Body:

    <CdpReplicaIntervals xmlns="http://www.veeam.com/ent/v1.0">
     <StartDate>2021-02-16T23:14:49</StartDate>
     <EndDate>2021-02-17T23:14:49</EndDate>
     <HasApplicationConsistentState>false</HasApplicationConsistentState>
     <Intervals>
       <Interval>
         <StartDate>2021-02-17T15:31:30</StartDate>
         <EndDate>2021-02-17T15:31:40</EndDate>
         <Rpo>10</Rpo>
       </Interval>
       <Interval>
         <StartDate>2021-02-17T15:31:40</StartDate>
         <EndDate>2021-02-17T23:15:00</EndDate>
         <Rpo>20</Rpo>
       </Interval>
     </Intervals>
     <RestorePoints>
       <RestorePoint>
         <Id>734bc0a7-f562-41df-a87c-b83db587c533</Id>
         <Date>2021-02-17T02:00:25</Date>
         <IsApplicationConsistent>false</IsApplicationConsistent>
       </RestorePoint>
       <RestorePoint>
         <Id>e5216614-053b-466b-a9c8-37392f05ec8e</Id>
         <Date>2021-02-17T08:00:26</Date>
         <IsApplicationConsistent>false</IsApplicationConsistent>
       </RestorePoint>
       <RestorePoint>
         <Id>57be0211-c6bd-4ebe-9046-e291d054a31c</Id>
         <Date>2021-02-17T14:00:25</Date>
         <IsApplicationConsistent>false</IsApplicationConsistent>
       </RestorePoint>
       <RestorePoint>
         <Id>1e4b6d3b-df38-4985-b6f2-6cf4e773a3ab</Id>
         <Date>2021-02-17T20:00:26</Date>
         <IsApplicationConsistent>false</IsApplicationConsistent>
       </RestorePoint>
     </RestorePoints>
    </CdpReplicaIntervals>

     

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.