GET /cloud/failoverSessions/{ID}

In this article

    Returns a cloud failover session that has the specified ID.

    Request

    To get a cloud failover session with the specified ID, send the GET HTTP request to the URL of the /cloud/failoverSessions/{ID} resource.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/cloud/failoverSessions/{ID}

    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

    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 an entity or an entity reference of the /cloud/failoverSessions/{ID} resource. The resource entity contains the following parameters and links.

    Parameters

    Element

    Type

    Description

    UID

    UidType

    UID of the cloud failover session resource, for example: urn:veeam:CloudFailoverSession:475420ee-d045-4493-9869-0a970e08f6f9.

    Name

    String

    Name of the cloud failover session resource, for example: ABC Company Failover Plan.

    JobType

    String

    Type of the cloud failover session. Possible value: FailoverPlan.

    CreationTimeUTC

    DateTime

    Date and time when the cloud failover session was started.

    EndTimeUTC

    DateTime

    Date and time when the cloud failover session was ended.

    State

    String

    State of the cloud failover session. Possible values:

    • Starting
    • Stopping
    • Working
    • Stopped

    Result

    String

    Result of the cloud failover session. Possible values:

    • Success
    • Warning
    • Failed

    Progress

    Int

    Progress of the cloud failover session (between 1 and 100).

    FailureMessage

    String

    Reason for which the cloud failover session has been completed with the Failed result.

    CloudFailoverTasks

    CloudFailoverTaskSessionInfoListType

    List of cloud failover task sessions. For details, see Cloud Failover Task Session.

    To view query parameters that you can use for filtering or sorting, see GET /query?type=CloudFailoverSession.

    Cloud Failover Task Session

    The CloudFailoverTasks element contains the following options of a cloud failover task session.

    Element

    Type

    Description

    VmReplicaPointLink

    Link

    URL of the /cloud/vmReplicaPoints/{ID} resource — a VM replica point processed by this task session.

    CreationTimeUTC

    DateTime

    Date and time when the cloud failover task session was started.

    EndTimeUTC

    DateTime

    Date and time when the cloud failover task session was ended.

    State

    String

    State of the cloud failover task session. Possible values:

    • Starting
    • Stopping
    • Working
    • Stopped

    Result

    String

    Result of the cloud failover task session. Possible values:

    • Success
    • Warning
    • Failed

    Progress

    Int

    Progress of the cloud failover task session (between 1 and 100).

    FailureMessage

    String

    Reason for which the cloud failover task session has been completed with the Failed result.

    Links

    Reference

    Relationship

    Description

    /backupServers/{ID}

    Up

    URL of the /backupServers/{ID} resource — a backup server of the Service Provider.

    /cloud/failoverSessions/{ID}

    Alternate

    Alternate URL of the /cloud/failoverSessions/{ID} resource.

    Example

    The example below returns an entity resource representation of the cloud failover session with ID 4347c445-c6a7-418a-877c-9d39b77a8933.

    Request:

    GET https://localhost:9398/api/cloud/failoverSessions/4347c445-c6a7-418a-877c-9d39b77a8933?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <?xml version="1.0" encoding="utf-8"?>
    <CloudFailoverSession xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://enterprise06.tech.local:9398/api/cloud/failoverSessions/4347c445-c6a7-418a-877c-9d39b77a8933?format=Entity" Type="CloudFailoverSession" Name="Cloud failover plan 1" UID="urn:veeam:CloudFailoverSession:4347c445-c6a7-418a-877c-9d39b77a8933" xmlns="http://www.veeam.com/ent/v1.0">
       <Links>
           <Link Href="https://enterprise06.tech.local:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" Type="BackupServerReference" Rel="Up" />
           <Link Href="https://enterprise06.tech.local:9398/api/cloud/failoverSessions/4347c445-c6a7-418a-877c-9d39b77a8933" Name="Cloud failover plan 1" Type="CloudFailoverSessionReference" Rel="Alternate" />
       </Links>
       <JobType>FailoverPlan</JobType>
       <CreationTimeUTC>2021-11-04T21:39:59.103Z</CreationTimeUTC>
       <State>Working</State>
       <Result>None</Result>
       <Progress>0</Progress>
       <CloudFailoverTasks>
           <CloudFailoverTasks VmName="apache05">
               <VmReplicaPointLink Href="https://enterprise06.tech.local:9398/api/cloud/vmReplicaPoints/262824bd-525f-41b6-89c6-ec1b8cb703b3" Name="apache05@2021-11-04 18:01:08" Type="CloudVmReplicaPointReference" Rel="Related" />
               <CreationTimeUTC>2021-11-04T21:40:03.62Z</CreationTimeUTC>
               <State>Working</State>
               <Result>None</Result>
               <Progress>0</Progress>
           </CloudFailoverTasks>
       </CloudFailoverTasks>
    </CloudFailoverSession>