[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

Get Stats Of Resources

Description

This is a GET endpoint and the query parameters control the data that is retrieved. If the number of Resources for which one needs to query data is large, it is recommended to use the POST /api/stats/query endpoint to avoid the URL length limitations. Takes the form: api/resources/stats?resourceId=UUID1 OR api/resources/stats?resourceId=UUID2&statKey=cpu|usagemhz&rollUpType=&begin=&end=

Request

Request

URL

URL


get
https://localhost/suite-api/api/resources/stats
Copy

Query Parameters

Query Parameters

integer
begin Optional

The beginning date as a long value of the range of stats to return Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC NOTE: If not provided, 24 hour rearward of ending date is used


boolean
currentOnly Optional

Indicates whether to report only “current” stat values, i.e. skip the stat-s that haven’t published any value during recent collection cycles.


boolean
dt Optional

Indicates that the requested stats are based on some dynamic threshold. Defaults to false which indicates that stats are not based on dynamic threshold.


integer
end Optional

The ending date as a long value of the range of stats to return Long value is number of milliseconds since January 1, 1970 00:00:00 UTC NOTE: The ending date must not be less than the beginning date. If not provided, current time as UTC milliseconds is used


integer
intervalQuantifier Optional

Number for the interval type


string
intervalType Optional

Interval type requested by the user (e.g: Days, Weeks, Months etc.)

Possible values are: HOURSMINUTESSECONDSDAYSWEEKSMONTHSYEARS


integer
latestMaxSamples Optional

The maximum number of samples to return when querying latest. When processing the get latest stats query if it is omitted a value of 1 is assumed. A query for the latest samples is not compatible with specifying the RollUpType value.


boolean
metrics Optional

Indicates whether specified statKey-s of query should be forcibly treated as metrics


array
resourceId Optional

Array of Resource ids for which the stats should be fetched


string
rollUpType Optional

Rollup Type requested by the user (e.g.: AVG, MIN, MAX etc.)

Possible values are: SUMAVGMINMAXNONELATESTCOUNT


array
statKey Optional

Array of stat keys for which the stats should be returned


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns StatsOfResources of type(s) application/json, application/xml, text/csv

The object containing a map of list of stat objects keyed by each Resource identifier

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://localhost/suite-api/api/resources/stats


Feedback

Was this page helpful?