Performance Manager Query Perf Composite

Performance Manager Query Perf Composite

Retrieves a PerfCompositeMetric data object that comprises statistics for the specified entity and its children entities.

Only metrics for the first level of descendents are included in the PerfCompositeMetric object.

Use this operation to obtain statistics for a host and its associated virtual machines, for example.

Requires system.read privilege for every virtual machine on the target host, or the query fails with the “NoPermission” fault. Suported for HostSystem managed entities only.

Required privileges: System.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/PerformanceManager/{moId}/QueryPerfComposite
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
QueryPerfCompositeRequestType of type(s) application/json
Required
"QueryPerfCompositeRequestType Object"
querySpec
Required

A PerfQuerySpec object specifying the query parameters. This PerfQuerySpec object specifies a managed object for which composite statistics should be retrieved, with specific optional criteria for filtering the results.

This PerfQuerySpec requires a valid PerfQuerySpec.metricId property that specifies a metric that is available, in common, to the entity and its children. If the specified metricId is not available to the entity and its children, it is ignored.

Authentication
This operation uses the following authentication methods.
Responses
200

The metric values for the specified entity and its associated entities for a single interval.

Returns PerfCompositeMetric of type(s) application/json
"PerfCompositeMetric Object"
entity
Optional

The aggregated entity performance metrics.

If it exists, the PerfSampleInfo list of the aggregate entity is a complete list of PerfSampleInfo that could be contained in PerfSampleInfo lists of child entities.

array of object
childEntity
Optional

A list of metrics of performance providers that comprise the aggregated entity.

For example, Host is an aggregated entity for virtual machines and virtual machine Folders. ResourcePools are aggregate entities for virtual machines. Host, Folder, and Cluster are aggregate entities for hosts in the cluster or folder.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PerformanceManager/{moId}/QueryPerfComposite