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://{vcenter-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 8.0.2.0 APIs.

Request Body

QueryPerfCompositeRequestType of type(s) application/json

Required

{
    "querySpec": {
        "_typeName": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "startTime": "string",
        "endTime": "string",
        "maxSample": 0,
        "metricId": [
            {
                "_typeName": "string",
                "counterId": 0,
                "instance": "string"
            }
        ],
        "intervalId": 0,
        "format": "string"
    }
}

PerfQuerySpec

querySpec

Required

This data object specifies the query parameters, including the managed object reference to the target entity for statistics retrieval.

If the optional intervalId is omitted, the metrics are returned in their originally sampled interval.
- When an intervalId is specified, the server tries to summarize the information for the specified intervalId. However, if that interval does not exist or has no data, the server summarizes the information using the best interval available.
If the range between startTime and endTime crosses multiple sample interval periods, the result contains data from the longest interval in the period.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

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

Returns PerfCompositeMetric of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "entity": {
        "_typeName": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    },
    "childEntity": [
        {
            "_typeName": "string",
            "entity": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ]
}

PerfEntityMetricBase

entity

Optional

Base type for the various PerfEntityMetric encodings.

array of PerfEntityMetricBase

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.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Performance Manager Operations

POST

Performance Manager Create Perf Interval

GET