ObjectInfoResponse

ObjectInfoResponse
Object Info Response

Object Info response.

JSON Example
{
    "start_time": 0,
    "end_time": 0,
    "granularity": "string",
    "resource_type": "string",
    "results": [
        {
            "resource_id": "string",
            "site_id": "string",
            "display_name": "string",
            "key_results": [
                {
                    "key": "string",
                    "object_results": [
                        {
                            "object_id": "string",
                            "object_description": "string",
                            "node_id": "string",
                            "node_path": "string",
                            "node_name": "string"
                        }
                    ]
                }
            ]
        }
    ]
}
integer As int64 As int64
start_time
Optional

Epoch time in milliseconds. Actual start time of the data being reported.

integer As int64 As int64
end_time
Optional

Epoch time in milliseconds. Actual end time of the data being reported.

MetricsGranularity
granularity
Optional

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.
Possible values are : FIVE_MINUTES, ONE_HOUR, ONE_DAY,
string
resource_type
Optional

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.

array of ObjectInfoResourceResultEntry
results
Optional

Collection of per resource entity and metric key object results.

Returned By