GET /cloud/cloudFailoverPlans/{ID}

In this article

    Returns a resource representation of the cloud failover plan that has the specified ID.

    Request

    To get a resource representation of the cloud failover plan, send the GET HTTP request to the URL of the /cloud/cloudFailoverPlans/{ID} resource:

    HTTP Request

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

    or

    GET https://<Enterprise-Manager>:9398/api/cloud/cloudFailoverPlans/{ID}?format=Entity

    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/cloudFailoverPlans/{ID} resource. The resource entity contains the following parameters and links.

    Parameters

    Element

    Type

    Description

    UID

    UidType

    UID of the failover plan, for example: urn:veeam:FailoverPlan:ae01e36f-32a3-4095-95fa-09a2af744009.

    Name

    String

    Name of the failover plan, for example: SQL Failover Plan.

    TenantUid

    UidType

    UID of the cloud tenant account, for example: urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89

    TenantName

    String

    Name of the cloud tenant account, for example: john.smith.

    Description

    String

    Description of the failover plan specified at the time of the failover plan creation.

    CloudFailoverPlanOptions

    CloudFailoverPlanOptionsInfoType

    Defines custom pre-failover and post-failover scripts for the cloud failover plan. For details, see Cloud Failover Plan Options.

    CloudFailoverPlanInfo

    CloudFailoverPlanInfoType

    Contains a list of VMs added to the cloud failover plan. For details, see /cloud/cloudFailoverPlans/{ID}/includes.

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

    Cloud Failover Plan Options

    The CloudFailoverPlanOptions element contains the following cloud failover plan options.

    Element

    Type

    Description

    PostFailoverPlanCommandEnabled

    Boolean

    Defines whether custom post-failover script is specified for the cloud failover plan. Possible values:

    • True
    • False

    PostFailoverPlanCommand

    String

    Path to the custom post-failover script, for example: C:\scripts\post-failover.bat

    PreFailoverPlanCommandEnabled

    Boolean

    Defines whether custom pre-failover script is specified for the cloud failover plan. Possible values:

    • True
    • False

    PreFailoverPlanCommand

    String

    Path to the custom pre-failover script, for example: C:\scripts\pre-failover.bat.

    Links

    Reference

    Relationship

    Description

    /backupServers/{ID}

    Up

    URL of the /backupServers/{ID} resource — a backup server where the cloud hardware plan was created.

    /cloud/cloudFailoverPlans/{ID}

    Alternate

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

    /cloud/cloudFailoverPlans/{ID}

    Edit

    URL for the PUT /cloud/cloudFailoverPlans/{ID} request.

    /cloud/cloudFailoverPlans/{ID}?action=start

    Start

    URL for the POST /cloud/cloudFailoverPlans/{ID}?action=start request.

    /cloud/cloudFailoverPlans/{ID}?action=test

    Test

    URL for the POST /cloud/cloudFailoverPlans/{ID}?action=test request.

    /cloud/cloudFailoverPlans/{ID}?action=undo

    Undo

    URL for the POST /cloud/cloudFailoverPlans/{ID}?action=undo request.

    /cloud/cloudFailoverPlans/{ID}

    Delete

    URL for the DELETE /cloud/cloudFailoverPlans/{ID} request.

    Example

    The example below returns an entity representation of the cloud failover plan that has ID e8d3df9a-70ba-492e-b39d-ab772e7defd5:

    Request:

    GET https://localhost:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <?xml version="1.0" encoding="utf-8"?>
    <CloudFailoverPlan 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/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5?format=Entity" Type="CloudFailoverPlan" Name="Cloud failover plan 1" UID="urn:veeam:CloudFailoverPlan:e8d3df9a-70ba-492e-b39d-ab772e7defd5" 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/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5" Name="Cloud failover plan 1" Type="CloudFailoverPlanReference" Rel="Alternate" />
           <Link Href="https://enterprise06.tech.local:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5" Name="Cloud failover plan 1" Type="CloudFailoverPlanReference" Rel="Edit" />
           <Link Href="https://enterprise06.tech.local:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5?action=start" Rel="Start" />
           <Link Href="https://enterprise06.tech.local:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5?action=test" Rel="Test" />
           <Link Href="https://enterprise06.tech.local:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5?action=undo" Rel="Undo" />
           <Link Href="https://enterprise06.tech.local:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5" Name="Cloud failover plan 1" Type="CloudFailoverPlanReference" Rel="Delete" />
       </Links>
       <TenantUid>urn:veeam:CloudTenant:34f546cf-5a72-4b12-8812-4a0ac093c661</TenantUid>
       <TenantName>john.smith</TenantName>
       <Description>Created by ENTERPRISE02\Administrator</Description>
       <CloudFailoverPlanOptions>
           <PostFailoverPlanCommandEnabled>false</PostFailoverPlanCommandEnabled>
           <PostFailoverPlanCommand />
           <PreFailoverPlanCommandEnabled>false</PreFailoverPlanCommandEnabled>
           <PreFailoverPlanCommand />
       </CloudFailoverPlanOptions>
       <CloudFailoverPlanInfo>
           <Includes>
               <CloudFailoveredVm Href="https://enterprise06.tech.local:9398/api/cloud/cloudFailoverPlans/e8d3df9a-70ba-492e-b39d-ab772e7defd5/includes/592cd62d-c7a2-4f19-a545-ed73ab696e42" Type="CloudFailoveredVm">
                   <FailoverPlanVMId>592cd62d-c7a2-4f19-a545-ed73ab696e42</FailoverPlanVMId>
                   <Name>apache05</Name>
                   <Order>0</Order>
               </CloudFailoveredVm>
           </Includes>
       </CloudFailoverPlanInfo>
    </CloudFailoverPlan>