Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(GET) /cloud/cloudFailoverPlans/{ID}/includes/{ID}

Returns a representation of a VM with the specified ID that is added to the cloud failover plan with the specified ID.

Request

To get a representation of a VM added to the cloud failover plan, you need to send the GET HTTP request to the URL of the /cloud/cloudFailoverPlans/{ID}/includes/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/cloud/cloudFailoverPlans/{ID}/includes/{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. To learn more, see Authentication and Security.

Request Body

None.

Query Parameters

The following parameters can be used in queries.

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

Uid

String

ID of the VM added to the cloud failover plan, for example: 231a6e3e-09e6-4641-9322-40898fcb966a.

True

True

Name

String

Name of the VM added to the cloud failover plan, for example: DC-SRV.

True

True

DisplayName

String

Name of the VM added to the cloud failover plan as displayed in the tenant virtualization infrastructure interface, for example: DC-SRV.

True

True

Order

Int64

Order number for processing the VM by the cloud failover plan. The processing sequence starts with 0.

True

True

JobUid

String

ID of the cloud failover plan parent to the VM resource, for example: e7ca6822-a87f-443d-8aae-8005970543bf.

.

True

True

JobName

String

Name of the cloud failover plan parent to the VM resource, for example: ABC Company Failover Plan.

True

True

BackupServerUid

URN

ID of the Veeam backup server on which the cloud failover plan parent to the VM resource is stored, for example: urn:veeam:BackupServer:8fff3b8e-c3f1-4ef5-aecc-561f07bf9982.

True

True

BackupServerName

String

Name of the Veeam backup server on which the cloud failover plan parent to the VM resource is stored, for example: BACKUPSERVER.

True

True

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

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: application/xml.

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/cloudFailoverPlans/{ID}/includes/{ID} resource.

Example

A sample request below returns a resource representation of the VM with ID 231a6e3e-09e6-4641-9322-40898fcb966a that is processed by the cloud failover plan with ID e7ca6822-a87f-443d-8aae-8005970543bf.

Request:

GET http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf/includes/231a6e3e-09e6-4641-9322-40898fcb966a

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<CloudFailoveredVm xmlns="http://www.veeam.com/ent/v1.0" Type="CloudFailoveredVm" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf/includes/231a6e3e-09e6-4641-9322-40898fcb966a">
 <Links>
   <Link Rel="Delete" Type="ObjectInJob" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf/includes/231a6e3e-09e6-4641-9322-40898fcb966a" Name="srv38" />
 </Links>
 <FailoverPlanVMId>231a6e3e-09e6-4641-9322-40898fcb966a</FailoverPlanVMId>
 <Name>srv38</Name>
 <Order>0</Order>
</CloudFailoveredVm>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation