This API has a deprecated equivalent from v7.0U1.
Query Monitoring
DescriptionGet 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, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
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": "enum",
"interval": "enum",
"name": "string",
"start_time": "string"
}
]
array of
string
data
Required
list of values
string
end_time
Required
End time in UTC
function
Required
aggregation function
Possible values are: COUNT , MAX , AVG , MIN
interval
Required
interval between values in hours, minutes
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
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
Errors
Availability
Added in 7.0U2
