REST API - get

appliance monitoring: get

Get monitored item info

Request:

HTTP request

GET https://{server}/rest/appliance/monitoring/{stat_id}

Path Parameters

Name	Type	Description
Required
stat_id	string	statistic item id.

Response:

HTTP Status Code: 200

Representations:

JSON
XML

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

<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/monitoring" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <id>obj-103</id>
    <category>string</category>
    <description>string</description>
    <name>string</name>
    <instance>string</instance>
    <units>string</units>
  </value>
</ns0:Get-Result>

Response Type:

Name	Type	Description
bold = required
value	monitored_item	MonitoredItem structure.
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