InlineMetricsTimeSeriesExportRequest1
Additional properties specific to time-series export requests.
{
"resource_type": "string",
"resource_ids": [
"string"
],
"granularity": "string",
"start_time": 0,
"end_time": 0,
"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",
"object_ids": [
"string"
],
"node_ids": [
"string"
],
"site_ids": [
"string"
],
"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,
"include_deleted_resources": false
}This is a required field. Resource Type for which metric keys and their information is requested for. Examples of supported NSX resource types are PolicyEdgeNode, HostTransportNode, Tier0Interface, Tier1Interface, Tier0, Tier1, Rule, SegmentPort. Examples 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 the 'id' or 'path' field on the NSX API output. For example, '/infra/tier-0s/tier0-providerA' or '/cluster'. If you want to fetch aggregate metrics across all resource_ids then "*" should be passed here and aggregate_resource_ids should be set to 'true' along with the appropriate aggregate_operation. Please note, not all metric keys support aggregation across resource_ids. Use the '/key-info' API to check which keys have aggregate_by_resource_ids set to 'true'. If resource_ids are UUIDs as opposed to intent paths, make sure all the resource_ids are associated with the correct resource_type.
Granularity of the metrics data required. Defaults are based on the following settings:
- If time-range is <= 12 hours, the default is 5-minute granularity.
- If time-range is > 12 hours and <= 7 days, the default is 1-hour granularity.
- If time-range is more than 7 days, the default is 1-day granularity. If you are looking for a coarser value, use this field. For example, if ONE_HOUR is set, the system will aggregate all the data points available within one hour and return the aggregated metric value. This field is not relevant (and is ignored) for "is_status" metrics.
Start time interval for the metrics query. Epoch time in milliseconds. Default values are as follows: Start time will be based on the end time and granularity, if provided. For FIVE_MIN granularity, end_time is - 12 hours. For ONE_HOUR granularity, end_time is - 1 week. For ONE_DAY granularity, end_time is - 1 month. If end time and granularity are not provided, granularity will be defaulted to FIVE_MIN and start time would be 12 hours before the end time.
End time interval for the metrics query. Epoch time in milliseconds. Default values are as follows - End time will be based on the start time and granularity if provided. For FIVE_MIN granularity, end_time will be start_time + 12 hours or current time whichever is earlier, for ONE_HOUR granularity, end_time will be start_time + 1 week or current time whichever is earlier, and for ONE_DAY granularity, end_time will be start_time + 1 month or current time whichever is earlier. If start time and granularity are not provided, granularity will be defaulted to FIVE_MIN and end time will be current time.
Request for related metrics for resource_ids that are related to related_resource_ids. It can be used along with other fields like resource_ids and resource_type. It acts as a filter to fetch metrics related to the related_resource_ids and related_resource_type. If both related_resource_ids and resource_ids are provided in the request, the API will only return the metrics for resource_ids that are 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.
Optional. A list of object IDs to filter the metrics.
Optional. A list of node IDs to filter the metrics.
Optional. A list of site IDs for which metrics data is being queried.
Time-series aggregation object. Aggregates 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 the 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.
Whether to include deleted resources in the response. If set to true, the response will include data points for deleted resources. By default, deleted resources are not included in the response. Currently, this flag is only supported for Rule resource type.