This API has a deprecated equivalent from v7.0U1.
List Monitoring
Get monitored items list
Request
URLURL
https://{api_host}/api/appliance/monitoring
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
MonitoringMonitoredItem
of type application/json
list of names
[
{
"category": "string",
"description": "string",
"id": "string",
"instance": "string",
"name": "string",
"units": "string"
}
]
string
category
Required
category Ex: network, storage etc
string
description
Required
monitored item description Ex: com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0
string
id
Required
monitored item ID Ex: CPU, MEMORY 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
instance
Required
instance name Ex: eth0
string
name
Required
monitored item name Ex: “Network write speed”
string
units
Required
Y-axis label EX: “Mbps”, “%”
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-ListMonitoring
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/monitoring
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
x-vmw-doc-operation: list
Availability
Added in 7.0U2
