Returns a collection of cloud failover sessions performed on all Veeam backup servers connected to Veeam Backup Enterprise Manager. A new cloud failover session is started every time you start or undo a cloud failover plan. When the start or undo a cloud failover plan operation completes, a cloud failover session ends
Request
To get a list of cloud failover sessions, you need to send the GET HTTP request to the URL of the /cloud/failoverSessions resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/cloud/failoverSessions |
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. To learn more, 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.
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 /cloud/failoverSessions resource.
Example
The example below returns a collection resource listing cloud failover sessions performed on all Veeam backup servers connected to Veeam Backup Enterprise Manager.
Request: GET https://localhost:9398/api/cloud/failoverSessions Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref 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>
</Ref>
<Ref Type="CloudFailoverSessionReference" Href="https://localhost:9398/api/cloud/failoverSessions/10c5b348-dcbb-4d50-8b37-0e0fb4daf0ef" Name="ABC Company Cloud Failover Plan" UID="urn:veeam:CloudFailoverSession:10c5b348-dcbb-4d50-8b37-0e0fb4daf0ef">
<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/10c5b348-dcbb-4d50-8b37-0e0fb4daf0ef?format=Entity" Name="ABC Company Cloud Failover Plan" />
</Links>
</Ref>
<Ref Type="CloudFailoverSessionReference" Href="https://localhost:9398/api/cloud/failoverSessions/030015e0-8f8f-469a-93e1-10b680b46887" Name="UCM Company Full SIte Failover" UID="urn:veeam:CloudFailoverSession:030015e0-8f8f-469a-93e1-10b680b46887">
<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/030015e0-8f8f-469a-93e1-10b680b46887?format=Entity" Name="UCM Company Full SIte Failover" />
</Links>
</Ref>
<Ref Type="CloudFailoverSessionReference" Href="https://localhost:9398/api/cloud/failoverSessions/15db3c3b-b561-4115-a3e3-24a7bfc50c35" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverSession:15db3c3b-b561-4115-a3e3-24a7bfc50c35">
<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/15db3c3b-b561-4115-a3e3-24a7bfc50c35?format=Entity" Name="ABC Company Failover Plan" />
</Links>
</Ref>
<Ref Type="CloudFailoverSessionReference" Href="https://localhost:9398/api/cloud/failoverSessions/77becc1b-d82e-46c8-93e7-2b59f6d31192" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverSession:77becc1b-d82e-46c8-93e7-2b59f6d31192">
<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/77becc1b-d82e-46c8-93e7-2b59f6d31192?format=Entity" Name="ABC Company Failover Plan" />
</Links>
</Ref>
...
</EntityReferences> |
