InlineMetricsDataRequest1
{
"keys": [
"string"
],
"resource_type": "string",
"resource_ids": [
"string"
],
"related_metrics_request": {
"conditions": [
{
"related_resource_type": "string",
"related_resource_ids": [
"string"
],
"metrics_condition_conjunction": "string"
}
],
"metrics_condition_conjunction": "string"
},
"aggregate_resource_ids": false,
"aggregate_operation": "string",
"max_num_data_points": 0,
"object_ids": [
"string"
],
"node_ids": [
"string"
],
"site_ids": [
"string"
],
"page_number": 0,
"page_size": 0,
"filter": {
"filter_components": [
{
"filter_field": "string",
"filter_operation": "string",
"value": "string",
"metrics_key": "string"
}
],
"metrics_condition_conjunction": "string"
},
"aggregation": {
"aggregation_dimension": "string",
"aggregation_function": "string"
},
"groupby": "string",
"include_partial_intervals": false
}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.
This is a required field. Resource Type for which metric keys and their information is requested for. Example of support NSX resource types are PolicyEdgeNode, HostTransportNode, Tier0Interface, Tier1Interface, Tier0, Tier1, Rule, SegmentPort. Example of supported (Security Services Platform) resource_types are SspCluster, SspNode and various SSP Services.
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.
Request for related metrics for resourceIds that are related to related_resource_ids. It can be used along with other fields resourceIds and resourceType. It act as filter to fetch metrics related to the related_resource_ids and related_resource_type. If user provide both related_resource_ids and resourceIds in request, API will only return the metrics for resourceIds and related to related_resource_ids.
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. This is valid only when aggregate_resource_ids is set to 'true'. Aggregation operation does not apply for 'status' metrics.
Number of distinct metrics data points to return. Distinct metric is defined by combination of resource_type + site_id + node_id + resource_id + obj_id + metric_key
Optional Input list of object ids to get a filtered list of metrics for select object_ids.
Optional Input list of node ids to get a filtered list of metrics for select node_ids.
Optional Input list of site ids for which metrics data is being queried for.
Used along with the page size to fetch the desired set of records
Maximum number of results to return in this page (server may return fewer)
Time-series aggregation object, Aggregate metrics across various dimensions.
Dimension to group the response. Grouping only works with aggregated data and the aggregation field can be used to control the aggregation_dimension and aggregation_function. In absence of the aggregation field, the aggregation_dimension will be defaulted to ALL_DIMENSIONS_WITH_TIME and the aggregation_function will be defaulted to SUM.
Whether to include partial intervals in the response. If set to true, the response will include data points for partial intervals at the beginning and end of the requested time range.