[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Aggregate Search Results

Description

Using aggregate API you can aggregate search results for vRealize Network Insight entities by specifying entity type, filter expression and aggregate clause. Please refer to API Guide on details of how to construct filter expression and aggregate clause. A successful search request will return a list of aggregations.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/search/aggregation
Copy

Request Body

Request Body

AggregationRequest of type(s) application/json Optional

Aggregation Request

{
	"aggregations": [
		{
			"aggregation_type": "SUM",
			"field": "flow.totalBytes.delta.summation.bytes"
		}
	],
	"entity_type": "Group",
	"filter": "string",
	"time_range": {
		"end_time": 1597247999,
		"start_time": 1597247025
	}
}
array of Aggregation
aggregations Optional

entity_type Optional

Possible values are: GroupBaseSecurityGroupBaseEventBaseVirtualMachineBaseFirewallRuleBaseFirewallSectionBaseIPSetBaseL2NetworkBaseFirewallBaseServiceBaseServiceGroupBaseVnicVirtualMachineEC2InstanceHostVnicVmknicVxlanLayer2NetworkVlanL2NetworkClusterSecurityTagResourcePoolNSXIPSetNSXTIPSetEC2IPSetNSXSecurityGroupNSGroupNSXPolicyGroupEC2SecurityGroupFlowProblemEventApplicationTierIPEndpointNSXFirewallRuleEC2SGFirewallRuleNSXRedirectRuleVCenterManagerNSXVManagerNSXTManagerNSXPolicyManagerCheckpointManagerCheckpointMDSManagerBaseManagerBaseFirewallManagerBaseNSXManagerNSXServiceEC2ServiceNSServiceVPCCloudNetworkAzureVMAzureNSGAzureASGAzureNSGRuleNSXDistributedFirewallEC2FirewallNSXServiceGroupNSServiceGroupDistributedVirtualSwitchDistributedVirtualPortgroupVCDatacenterDatastoreFolderNSXTFirewallRuleNSXTFirewallPolicyManagerFirewallRulePolicyManagerFirewallBaseGenericFirewallBaseGenericFirewallRuleCheckpointFirewallCheckpointFirewallRuleUserDefinedSubnetKubernetesServiceUserDefinedProblemEventFirewallRuleMaskEventEdgeDeviceRouterDeviceNSXControllerLogicalRouterNSXTManagementNodeNSXTControllerNSXTTransportNodeNSXTTransportZoneNSXTLoadBalancerNSXTVirtualServerNSXTServerPoolNSXTLogicalSwitchNSXTRouterDeviceNSXTEdgeClusterNSXControllerClusterAzureSubscriptionAWSAccountManagerHcxDataSourceVMCSDDCVMCCapacityThresholdBreachEventPolicyManagerSegmentPolicyManagerFirewallSectionDirectConnectInterface


string
filter Optional

query filter


time_range Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns AggregationResponse of type(s) application/json
{
	"aggregations": [
		{
			"aggregation_type": "SUM",
			"field": "string",
			"value": 0
		}
	],
	"end_time": 1597247999,
	"series_values": [
		{
			"aggregation_type": "SUM",
			"field": "string",
			"resolution_in_secs": 0,
			"series": [
				0
			]
		}
	],
	"start_time": 1597247025,
	"total_count": 100
}
aggregations Optional

integer as int64
end_time Optional

End timestamp of the window of the objects returned


array of SeriesValue
series_values Optional

integer as int64
start_time Optional

Start timestamp of the window of the objects returned


integer as int32
total_count Optional

Total count of objects returned

Errors

Errors

400

Bad Request


401

Unauthorized


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"aggregations":[{"aggregation_type":"SUM","field":"flow.totalBytes.delta.summation.bytes"}],"entity_type":"Group","filter":"string","time_range":{"end_time":1597247999,"start_time":1597247025}}' https://vrni.example.com/api/ni/search/aggregation


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?