REST API - list
  1. Operations
  2. appliance
  3. monitoring

appliance monitoring: list

Get monitored items list

Request:

HTTP request

GET https://{server}/rest/appliance/monitoring
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "instance" : "string",
            "name" : "string",
            "description" : "string",
            "id" : "obj-103",
            "units" : "string",
            "category" : "string"
        },
        {
            "instance" : "string",
            "name" : "string",
            "description" : "string",
            "id" : "obj-103",
            "units" : "string",
            "category" : "string"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value monitored_item[] list of names.
value[].id string 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.
value[].name string monitored item name Ex: "Network write speed"
value[].units string Y-axis label EX: "Mbps", "%"
value[].category string category Ex: network, storage etc
value[].instance string instance name Ex: eth0
value[].description string monitored item description Ex: com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0

Errors:

HTTP Status Code Type Description
500 error Generic error