InlineMetricsDataRequest1
{
"keys": [
"string"
],
"resource_type": "string",
"resource_ids": [
"string"
],
"aggregate_resource_ids": false,
"aggregate_operation": "string",
"max_num_data_points": 0,
"object_ids": [
"string"
],
"node_ids": [
"string"
],
"site_ids": [
"string"
],
"empty_value_config": {
"technique": "string"
}
}List of metric keys for which data is queried for. This is a required field. Use /key-info API to see which metric keys are supported for a given resource_type.
NSX Resource type for which metrics is queried for. This is a required field. Examples of few of the Supported NSX resource types are PolicyEdgeNode, ClusterNode, Tier0Interface, Tier1Interface, Tier0, Tier1. Refer to the 'resource_type' on NSX API output. Supported NAPP (NSX Application Platform) resource_types are Napp (Kubernetes cluster level) and NappNode (Kubernetes worker level).
List of NSX resource ids for which metrics data is being queried for. This can be 'id' or 'path' field on the NSX API output. E.g '/infra/tier-0s/tier0-providerA' or '/cluster'. If we want to fetch aggregate metrics across all resource_ids then "*" should be passed here and aggregate_resource_ids should be set 'true' along with appropriate aggregate_operation should be provided. Please note not all metric keys support aggregation across resource_ids. Users should use '/key-info' API to check which keys have aggregate_by_resource_ids set to 'true'. If resource_ids are UUID's as opposed to intent paths, make sure all the resource_ids are associated with the correct resource_type.
When this is set to 'true' we expect * to be passed for resource_ids field and the metrics values will be aggregated for all resources. The aggregate_operation must be specified when this flag is set to 'true'.
Aggregation operation to be performed on the data points being queried for. e.g. SUM of data points or AVG of the datapoints.
Number of data points to return. Maximum 600 datapoints is supported per unique combination of resource_type + site_id + node_id + resource_id + obj_id + metric_key.
Optional Input list of object ids for which metrics data is being queried for. all entities matching all combinations of resource_ids[i]/node_ids[j]/object_ids[k] will be returned. If object ids are not provided and a metric is reported per object id, we will return per resource_id/object_id.
Optional Input list of node ids for which metrics data is being queried for. all entities matching all combinations of resource_ids[i]/node_ids[j]/object_ids[k] will be returned. If node ids are not provided and a metric value is stored per node_id, we will return value for <resourceId, nodeId>.
Optional Input list of site ids for which metrics data is being queried for.
Configuration specifying how to populate empty data points in a time-series metric response