This is an archive version of the document. To get the most up-to-date information, see the current version.Get VMs Added to VM Group in Plan
You can get a list of all VMs added to a VM group with the specified ID included in a specific plan.
Request
To retrieve a representation of a collection of VMs added to a specific VM group, send the HTTP GET request to the /Groups/{groupId}/Vms endpoint.
Tip |
VAO entity can be edited by another user while you are working with the VAO REST API. To define whether to include changes of the current editing session to the response, specify the includeEditingChanges parameter after the endpoint of the request URL: ?includeEditingChanges=true/false. |
HTTP Request
GET https://<hostname>:<port>/api/v3/Plans/{planId}/Groups/{groupId}/Vms |
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 |
| 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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, VAO returns a representation of the /Vms collection for the specified VM group. The FailoverVmModel schema is used for the collection representation.
Example
The following request returns a list of VMs added in a VM group with the ID b0ed96ba-be18-4d3a-a658-613c8550e966 in a plan with the ID cd47d232-44f6-4c1c-84e2-8033049a5cfa.
|