POST /cloud/cloudFailoverPlans/{ID}?action=test
Tests a cloud failover plan that has the specified ID.
Request
To test a cloud failover plan, send the POST HTTP request to the /cloud/cloudFailoverPlans/{ID}?action=test URL.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/cloud/cloudFailoverPlans/{ID}?action=test |
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. |
Content-Type | True | Identifies the format of the request body message. Possible values:
|
Accept | False | Identifies the format of the response. Possible values:
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 202 Accepted.
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:
|
Response Body
In the response body, the REST API returns a task. Additionally, the REST API returns a URL to the task deletion operation. To stop the task execution, send the DELETE /task/{ID} request to the URL.
The task is created to start a cloud failover session. To track the status of the operation, send the GET /tasks/{ID} request.
The task with the Finished state contains a link to an entity representation of the cloud failover session. To track the session state, send the GET /cloud/failoverSessions/{ID} request.
Example
The example below tests a cloud failover plan that has ID 3f56fa52-c902-4655-9774-2022fde214d2.
Request: POST https://localhost:9398/api/cloud/cloudFailoverPlans/3f56fa52-c902-4655-9774-2022fde214d2?action=test
Request Headers: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the state of the received task, send the GET HTTP request to the URL of the task resource:
Request: GET https://localhost:9398/api/tasks/task-1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the testing progress, send the GET HTTP request to the URL of the received cloud failover session:
Request: GET https://localhost:9398/api/cloud/failoverSessions/a986d473-0248-4884-9832-17ec982ee393?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CloudFailoverSession xmlns="http://www.veeam.com/ent/v1.0" Type="CloudFailoverSession" Href="https://localhost:9398/api/cloud/failoverSessions/a986d473-0248-4884-9832-17ec982ee393?format=Entity" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverSession:a986d473-0248-4884-9832-17ec982ee393"> |