Query Latest Stats Of Resources Using POST

Query Latest Stats Of Resources Using POST

Get the last "maxSamples" stats values for specified one or more Resources

Request

URI

POST

https://{api_host}/api/resources/stats/latest/query

COPY

Request Body

The object which specifies the search criteria

latest-stat-query of type(s) application/json

Required

{
    "currentOnly": false,
    "maxSamples": 0,
    "metrics": false,
    "resourceId": [
        "string"
    ],
    "statKey": [
        "string"
    ]
}

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.

integer As int32 As int32

maxSamples

Optional

The maximum number of samples to return when querying latest stats. Defaults to 1 so that when processing the query if it is omitted the response would contain a single sample

boolean

metrics

Optional

Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)

array of string

resourceId

Optional

Array of Resource ids for which the latest stats should be fetched

array of string

statKey

Optional

Array of stat keys for which the latest stats should be returned

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The requested stats

Returns stats-of-resources of type(s) application/json

{
    "values": [
        {
            "resourceId": "string",
            "stats": {
                "stat": [
                    {
                        "data": [
                            "number"
                        ],
                        "dtTimestamps": [
                            0
                        ],
                        "intervalUnit": {
                            "intervalType": "string",
                            "quantifier": 0
                        },
                        "links": [
                            {
                                "description": "string",
                                "href": "string",
                                "name": "string",
                                "rel": "string"
                            }
                        ],
                        "maxThresholdData": [
                            "number"
                        ],
                        "minThresholdData": [
                            "number"
                        ],
                        "rollUpType": "string",
                        "smoothValues": [
                            "number"
                        ],
                        "statKey": {
                            "key": "string"
                        },
                        "timestamps": [
                            0
                        ],
                        "values": [
                            "string"
                        ]
                    }
                ]
            }
        }
    ]
}

array of stats-of-resource

values

Optional

Collection of resource-stat objects

404

Non of the resources could be found

Operation doesn't return any data structure

500

Error during the query

Operation doesn't return any data structure

On This Page

Request

200 Response Body

Errors

Resources Operations

Add Group Type Using POST

Add Stats For Resources Using POST

Add Stats For Resources Using Push Adapter Kind Using POST

Create Custom Group Using POST

Create Custom Profile Using POST

Create Resource Using Adapter Instance Using POST

Create Resource Using Adapter Kind Using POST

Delete Custom Group Using DELETE

Delete Custom Profile Using DELETE

Delete Group Type Using DELETE

Delete Resources Using DELETE

Get Custom Group Members Using GET

Get Custom Groups Using GET

Get Custom Group Using GET

Get Custom Profiles Using GET

Get Custom Profile Using GET

Get Group Types Using GET

Get Latest Stats Of Resources Using GET

Get Matching Resources Using POST

Get Resource Properties List Using GET

Get Resources Relationships Using POST

Get Resources Using GET

Get Stat Keys Of Resources Using GET

Get Stats And DT For Resources Using POST

Get Stats For Resources Using POST

Get Stats Of Resources Using GET

Get Top N Stats Of Resources Using GET

Mark Resources As Being Maintained Using PUT

Modify Custom Group Using PUT

Modify Custom Profile Using PUT

Query Latest Properties Of Resources Using POST

Query Latest Stats Of Resources Using POST

Start Monitoring Resources Using PUT

Stop Monitoring Resources Using PUT

Unmark Resources As Being Maintained Using DELETE

Update Resource Using PUT