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

Get Top N Stats Of Resource

Description

Get the TopN stats for a given Resource and given a set of attributes

Request

Request

URL

URL


get
https://localhost/suite-api/api/resources/{id}/stats/topn
Copy

Path Parameters

Path Parameters

string
id Required

The ID of the adapter kind that will push the stats


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


string
groupBy Optional

The type of grouping, if not set defaults to ResourceStatGroupBy.RESOURCE

Possible values are: RESOURCESTATKEY


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


string
sortOrder Optional

The type of sorting, if not set defaults to ResourceStatSort.ASCENDING

Possible values are: ASCENDINGDESCENDING


array
statKey Optional

Array of stat keys for which the stats should be returned


integer
topN Required

The number of results. Keep in mind if a grouping contains multiple items (eg: grouped by resource, with 4 metrics for the grouping resource) then returning the group with 4 metrics counts as 4 topN entries. If there are not enough remaining open topN entries to return an entire group within the topN then the entire group is not returned. *


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ResourceStatGroupList of type(s) application/json, application/xml

The TopN stats

{
	"groupBy": "RESOURCE",
	"resourceStatGroups": [
		{
			"groupKey": "string",
			"links": [
				{
					"description": "string",
					"href": "string",
					"name": "string",
					"rel": "NEXT"
				}
			],
			"resourceStats": [
				{
					"links": [
						{
							"description": "string",
							"href": "string",
							"name": "string",
							"rel": "NEXT"
						}
					],
					"resourceId": "string",
					"stat": {
						"data": [
							0
						],
						"dtTimestamps": [
							0
						],
						"intervalUnit": {
							"intervalType": "HOURS",
							"quantifier": 0
						},
						"links": [
							{
								"description": "string",
								"href": "string",
								"name": "string",
								"rel": "NEXT"
							}
						],
						"maxThresholdData": [
							0
						],
						"minThresholdData": [
							0
						],
						"rollUpType": "SUM",
						"smoothValues": [
							0
						],
						"statKey": {
							"key": "string"
						},
						"timestamps": [
							0
						],
						"values": [
							"string"
						]
					}
				}
			]
		}
	],
	"sortOrder": "ASCENDING"
}
string
groupBy Optional

Possible values are: RESOURCESTATKEY


resourceStatGroups Optional

string
sortOrder Optional

Possible values are: ASCENDINGDESCENDING

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://localhost/suite-api/api/resources/{id}/stats/topn?topN=10


Feedback

Was this page helpful?