Allows you to get a list of all registered tenant virtual machines.
Method:
GET /api/2.0/virtualization/tenants/{tenant ID
}/vms
where:
{
tenant ID
}
– tenant identifier in the Integration Server database (required parameter).
In case of successful completion of the request, the REST API returns a list of virtual machines and the following information about each tenant virtual machine:
<vm id="{
ID in the database
}" biosId={
BIOS ID} created="{
date and time
}" updated="{
date and time
}">
<name>{
name
}</name>
<userData><![CDATA[{
additional information
}]]></userData>
</vm>
where:
{
ID in the database
}
– identifier assigned to the virtual machine in the Integration Server database.{
BIOS ID}
– virtual machine identifier (BIOS ID) in UUID format.created="{
date and time
}"
– date and time when the virtual machine was registered in the Integration Server database in YYYY-MM-DDThh:mm:ss format.updated="{
date and time
}"
– date and time when the virtual machine data was updated in the Integration Server database in YYYY-MM-DDThh:mm:ss format.{
name
}
– virtual machine name.{
additional information
}
– additional information about the virtual machine stored in the Integration Server database.Return codes:
200 (OK)
– request completed successfully. The response returns a list of the tenant virtual machines.403 (Forbidden)
– access to the resource is denied.404 (Not Found) VIRMT_TenantWithSpecifiedIdNotFound
– tenant with the specified identifier is not found in the Integration Server database.