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 a representation of the /cloud/failoverSessions/{ID} resource.

    You can use the following parameters in the GET /query?type=CloudFailoverSession query:

    Parameter

    Type

    Description

    Can Be Used for Filtering

    Can Be Used for Sorting

    Uid

    URN

    ID of the cloud failover session resource, for example: 475420ee-d045-4493-9869-0a970e08f6f9.

    True

    True

    Name

    String

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

    True

    True

    Type

    String

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

    True

    True

    CreationTime

    DateTime

    Date and time when the cloud failover session was started. The parameter accepts only UTC-formatted DateTime values.

    True

    True

    EndTime

    DateTime

    Date and time when the cloud failover session was ended. The parameter accepts only UTC-formatted DateTime values

    True

    True

    State

    String

    State of the cloud failover session. Possible values:

    • Starting
    • Stopping
    • Working
    • Stopped

    True

    True

    Result

    String

    Result of the cloud failover session. Possible values:

    • Success
    • Warning
    • Failed

    True

    True

    FailureMessage

    String

     

    True

    True

    BackupServerUid

    URN

    ID of the backup server parent to the cloud failover session resource.

    True

    True

    BackupServerName

    String

    Name of the backup server parent to the cloud failover session resource.

    True

    True

    Example

    The example below returns a cloud failover session performed in Veeam Backup & Replication. The cloud failover session has ID 475420ee-d045-4493-9869-0a970e08f6f9.

    Request:

    GET https://localhost:9398/api/cloud/failoverSessions/475420ee-d045-4493-9869-0a970e08f6f9

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="CloudFailoverSessionReference" Href="https://localhost:9398/api/cloud/failoverSessions/475420ee-d045-4493-9869-0a970e08f6f9" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverSession:475420ee-d045-4493-9869-0a970e08f6f9">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
       <Link Rel="Alternate" Type="CloudFailoverSession" Href="https://localhost:9398/api/cloud/failoverSessions/475420ee-d045-4493-9869-0a970e08f6f9?format=Entity" Name="ABC Company Failover Plan" />
     </Links>
    </EntityRef>