Get VM By Usage

Get VM By Usage

Use this endpoint to Order Database VMs by specified Metric Usage using Environment UUID, Host Moid and Metric Key
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER

Request
URI
GET
https://{api_host}/monitoring/environments/{environmentId}/hosts/{hostMoid}/vms/filter-by-usage
COPY
Path Parameters
string
environmentId
Required

Environment UUID

string
hostMoid
Required

Host Moid

Query Parameters
string
orderby
Required

Order By Metric Key name

integer
duration
Required

Time Period

string
timeunit
Required

Time Unit

Possible values are : NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS,
integer
page
Optional

Zero-based page index (0..N)

integer
size
Optional

The size of the page to be returned

string of array
sort
Optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageVMUsageDTO of type(s) application/vnd.vmware.dms-v1+json 
{
    "totalElements": 0,
    "totalPages": 0,
    "pageable": {
        "page": 0,
        "size": 0,
        "sort": [
            "string"
        ]
    },
    "first": false,
    "sort": {
        "sorted": false,
        "unsorted": false,
        "empty": false
    },
    "size": 0,
    "content": [
        {
            "instanceName": "string",
            "dbUUID": "string",
            "usage": "number",
            "time": "string"
        }
    ],
    "number": 0,
    "numberOfElements": 0,
    "last": false,
    "empty": false
}
integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages

Pageable
pageable
Optional

pageable

boolean
first
Optional

first

Sort
sort
Optional

sort

integer As int32 As int32
size
Optional

size

array of VMUsageDTO
content
Optional

content

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

boolean
last
Optional

last

boolean
empty
Optional

empty


204

No Content

Returns ExceptionResponse of type(s) */* 
{
    "timestamp": "string",
    "message": "string",
    "details": "string",
    "uri": "string"
}
string As date-time As date-time
timestamp
Optional

timestamp

string
message
Optional

message

string
details
Optional

details

string
uri
Optional

uri


500

Internal Server Error

Returns ExceptionResponse of type(s) */* 
{
    "timestamp": "string",
    "message": "string",
    "details": "string",
    "uri": "string"
}
string As date-time As date-time
timestamp
Optional

timestamp

string
message
Optional

message

string
details
Optional

details

string
uri
Optional

uri


On This Page
Infrastructure Metrics Operations
GET
Find By Key With Duration Environment
GET
Get Datastore Metrics
GET
Get Datastores
GET
Get Hosts
GET
Get Hosts Metrics
GET
Get VM By Usage
GET
Get VM By Usage Associated With Namespace
GET
Get Vm Metrics
GET
Get V Ms