Get Details for Steps Added to Virtual Group in Plan

You can get runtime details for every atep added to a virtual group with the specified ID in a specific plan.

Request

To retrieve a representation of a collection for all steps added to a specific virtual group, send the HTTP GET request to to the /RuntimeDetails/Plans/{planId}/Groups/{groupId}/Steps endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v3/RuntimeDetails/Plans/{planId}/Groups/{groupId}/Steps

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

Optional

  • application/xml
  • text/json
  • application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 200 response code.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

In the response body, VAO returns a representation of the /RuntimeDetails collection for all steps added to the specified virtual group. The StepRuntimeDetails schema is used for the collection representation.

Get Details for Steps Added to Virtual Group in PlanExample

The following request returns runtime details for all steps added to a virtual group with the ID fa044a06-4dc4-4eb0-8948-0b04a8b69662 in a plan with the ID 62685fe6-222a-493d-a99b-feea900921a2.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/RuntimeDetails/Plans/62685fe6-222a-493d-a99b-feea900921a2/Groups/fa044a06-4dc4-4eb0-8948-0b04a8b69662/Steps

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "total": 2,

 "data": [

   {

     "actionType": "LicenseCheck",

     "hidden": false,

     "stepDefinitionUid": "d66d1602-e123-49df-b286-28862473659f",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.2592757Z",

       "finishTime": "2020-07-09T07:42:50.2592757Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "[General license status]License will expired in 288 days.",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         },

         {

           "friendlyInfo": "[General license usage]License usage on VAO Server is not exceeded.",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         },

         {

           "friendlyInfo": "[Instances used in plan]All VMs in the plan are licensed",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         }

       ]

     },

     "id": "f3e3935a-a3b6-4032-bb52-f4422b812f06",

     "name": "License Check",

     "progress": 100

   },

   {

     "actionType": "CheckRestoreLocation",

     "hidden": false,

     "stepDefinitionUid": "00000000-0000-0000-0000-000000000000",

     "executionState": "Completed",

     "executionResult": {

       "startTime": "2020-07-09T07:42:50.2592757Z",

       "finishTime": "2020-07-09T07:42:50.2592757Z",

       "result": "Success",

       "details": [

         {

           "friendlyInfo": "",

           "level": "Critical",

           "severity": "Info",

           "timestamp": "2020-07-09T07:42:50.2592757Z"

         }

       ]

     },

     "id": "9f56721c-751f-4ff8-bf45-2f761453caff",

     "name": "Check Recovery Location 'Original VM Location'",

     "progress": 100

   }

 ]

}

]

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.