Performance Manager Query Available Perf Metric

Performance Manager Query Available Perf Metric

Retrieves all performance counters for the specified managed object generated during a specified period of time.

The time period can be specified using beginTime, endTime, or by interval ID.

Required privileges: System.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/PerformanceManager/{moId}/QueryAvailablePerfMetric
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case PerformanceManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
QueryAvailablePerfMetricRequestType of type(s) application/json
Required 
"QueryAvailablePerfMetricRequestType Object"
entity
Required

The managed object that provides performance metrics.

string As date-time As date-time
beginTime
Optional

Starting time (server time) for a period of time from which to return available metrics. If not specified, defaults to oldest available metric for the specified entity.

string As date-time As date-time
endTime
Optional

Ending time (server time) for a period of time from which to return available performance metrics. If not specified, defaults to the most recently generated metric for the specified entity.

integer As int32 As int32
intervalId
Optional

Period of time from which to retrieve metrics, defined by intervalId (rather than beginTime or endTime). Valid intervalIds include:

  • For real-time counters, the refreshRate of the performance provider.
  • For historical counters, the samplingPeriod of the historical interval.

If this parameter is not specified, the system returns available metrics for historical statistics.

Authentication
This operation uses the following authentication methods.
Responses
200

An array of metrics, each of which comprises a counterId and an name.

[
    "PerfMetricId Object"
]
array of PerfMetricId
Optional

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PerformanceManager/{moId}/QueryAvailablePerfMetric
On This Page
Virtual Infrastructure Operations
POST
Performance Manager Create Perf Interval
Deprecated
POST
Performance Manager Query Available Perf Metric
POST
Performance Manager Query Perf Composite
POST
Performance Manager Query Perf Counter
POST
Performance Manager Query Perf Counter By Level
POST
Performance Manager Query Perf Provider Summary
POST
Performance Manager Query Perf
POST
Performance Manager Remove Perf Interval
Deprecated
POST
Performance Manager Reset Counter Level Mapping
POST
Performance Manager Update Counter Level Mapping
POST
Performance Manager Update Perf Interval
GET
Performance Manager Get Description
GET
Performance Manager Get Historical Interval
GET
Performance Manager Get Perf Counter