This API has a deprecated equivalent from v7.0U1.
Query Monitoring
Get monitoring data.
Request
URLURL
https://{api_host}/api/appliance/monitoring/query
Query Parameters
Query Parameters
string
end_time
Required
End time in UTC
array of
string
names
Required
monitored item IDs Ex: CPU, MEMORY When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.monitoring. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.monitoring.
string
start_time
Required
Start time in UTC
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
MonitoringMonitoredItemData
of type application/json
list of MonitoredItemData structure
[
{
"data": [
"string"
],
"end_time": "string",
"function": "COUNT",
"interval": "MINUTES30",
"name": "string",
"start_time": "string"
}
]
array of
string
data
Required
list of values
string
end_time
Required
End time in UTC
function
Required
Monitoring.FunctionType enumerated type Defines aggregation function
COUNT : Aggregation takes count per period (sum)
MAX : Aggregation takes maximums per period
AVG : Aggregation takes average per period
MIN : Aggregation takes minimums per period
Possible values are: COUNT , MAX , AVG , MIN
interval
Required
Monitoring.IntervalType enumerated type Defines interval between the values in hours and mins, for which aggregation will apply
MINUTES30 : Thirty minutes interval between values. One week is 336 values.
HOURS2 : Two hours interval between values. One month has 360 values.
MINUTES5 : Five minutes interval between values (finest). One day would have 288 values, one week is 2016.
DAY1 : 24 hours interval between values. One year has 365 values.
HOURS6 : Six hour interval between values. One quarter is 360 values.
Possible values are: MINUTES30 , HOURS2 , MINUTES5 , DAY1 , HOURS6
string
name
Required
Monitored item IDs Ex: CPU, MEMORY, STORAGE_TOTAL When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.monitoring. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.monitoring.
string
start_time
Required
Start time in UTC
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetMonitoringQuery -Names "MyNames" -Interval "MINUTES30" -Function "COUNT" -StartTime (Get-Date) -EndTime (Get-Date)
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/monitoring/query?end_time=string&function=string&interval=string&names=string&start_time=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/monitoring/query
x-vmw-doc-operation: query
Availability
Added in 7.0U2
