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
Constraints: default: 1

Page Number

integer
limit
Optional
Constraints: default: 20

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 
"metricsQuery Object"
array of object
stringFilters
Optional

stringFilters

array of object
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": {
        "opsAlertDetails": [
            {
                "name": "string",
                "criticality": "string",
                "updatedOn": "string",
                "createdOn": "string",
                "status": "string"
            }
        ],
        "alertsDetails": [
            "string"
        ],
        "status": "string"
    },
    "vcopsUuid": "string",
    "iaasUuid": "string",
    "expirationDate": "string"
}
boolean
pendingRequest
Optional

pendingRequest

array of object
strings
Optional

strings

string
moref
Optional

moref

array of object
stats
Optional

stats

number As double As double
dailyCost
Optional

dailyCost

string
serverGuid
Optional

serverGuid

object
health
Optional

health

string
vcopsUuid
Optional

vcopsUuid

string
iaasUuid
Optional

iaasUuid

string As date-time As date-time
expirationDate
Optional

expirationDate


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/management-service/api/management/metrics
On This Page
Reclamation Operations
POST
Cancel Reclamation Requests
PUT
Get Certificate
POST
Process Callback
POST
Create Management Endpoint
GET
Get Management Endpoint
DELETE
Remove Management Endpoint
PUT
Update Management Endpoint
PUT
Get Vm Performance Metrics
GET
Is Vrops Configured
PUT
Test Connection
GET
Get Vm Performance Metrics For Vm
GET
Get Reclamation Requests
POST
Create Work Items