Get Vm Performance Metrics

Get Vm Performance Metrics

Get VM performance metrics, based on the passed query.

Request
URI
PUT
https://{api_host}/management-service/api/management/metrics
COPY
Query Parameters
integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Request Body

Performance Metrics Query

metricsQuery of type(s) application/json
Required
{
    "stringFilters": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "statFilters": [
        {
            "stat": "string",
            "value": "number",
            "operation": "string"
        }
    ],
    "toExpirationDate": "string",
    "fromExpirationDate": "string"
}
stringFilters
Optional

stringFilters

statFilters
Optional

statFilters

string As date-time As date-time
toExpirationDate
Optional

toExpirationDate

string As date-time As date-time
fromExpirationDate
Optional

fromExpirationDate

Responses
200

Success. Returns a VmResource

Returns vmresource of type(s) */*
{
    "pendingRequest": false,
    "strings": [
        {
            "propertyName": "string",
            "value": "string"
        }
    ],
    "moref": "string",
    "stats": [
        {
            "statName": "string",
            "value": "number"
        }
    ],
    "dailyCost": "number",
    "serverGuid": "string",
    "health": {
        "alertsDetails": [
            "string"
        ],
        "status": "string"
    },
    "vcopsUuid": "string",
    "iaasUuid": "string",
    "expirationDate": "string"
}
boolean
pendingRequest
Optional

pendingRequest

strings
Optional

strings

string
moref
Optional

moref

array of StatMetric
stats
Optional

stats

number As double As double
dailyCost
Optional

dailyCost

string
serverGuid
Optional

serverGuid

health
Optional

health

string
vcopsUuid
Optional

vcopsUuid

string
iaasUuid
Optional

iaasUuid

string As date-time As date-time
expirationDate
Optional

expirationDate