Group Search Results
DescriptionUsing groupby search API you can group search results for vRealize Network Insight entities by specifying entity type, filter expression, aggregate clause and groupby clause. Please refer to API Guide on details of how to construct filter expression, aggregate clause and groupby clause. A successful search request will return a list of groups.
Request
URLURL
Request Body
{
"aggregations": [
{
"aggregation_type": "SUM",
"field": "flow.totalBytes.delta.summation.bytes"
}
],
"entity_type": "Flow",
"filter": "destination_ip.ip_address = '1.1.1.1'",
"group_by": [
"source_ip",
"destination_ip"
],
"size": 2,
"sort_by": [
{
"aggregation_type": "SUM",
"field": "flow.totalBytes.delta.summation.bytes",
"order": "DESC"
}
],
"time_range": {
"end_time": 1534410559,
"start_time": 1534410000
}
}
Possible values are: Group , BaseSecurityGroup , BaseEvent , BaseVirtualMachine , BaseFirewallRule , BaseFirewallSection , BaseIPSet , BaseL2Network , BaseFirewall , BaseService , BaseServiceGroup , BaseVnic , VirtualMachine , EC2Instance , Host , Vnic , Vmknic , VxlanLayer2Network , VlanL2Network , Cluster , SecurityTag , ResourcePool , NSXIPSet , NSXTIPSet , EC2IPSet , NSXSecurityGroup , NSGroup , NSXPolicyGroup , EC2SecurityGroup , Flow , ProblemEvent , Application , Tier , IPEndpoint , NSXFirewallRule , EC2SGFirewallRule , NSXRedirectRule , VCenterManager , NSXVManager , NSXTManager , NSXPolicyManager , CheckpointManager , CheckpointMDSManager , BaseManager , BaseFirewallManager , BaseNSXManager , NSXService , EC2Service , NSService , VPC , CloudNetwork , AzureVM , AzureNSG , AzureASG , AzureNSGRule , NSXDistributedFirewall , EC2Firewall , NSXServiceGroup , NSServiceGroup , DistributedVirtualSwitch , DistributedVirtualPortgroup , VCDatacenter , Datastore , Folder , NSXTFirewallRule , NSXTFirewall , PolicyManagerFirewallRule , PolicyManagerFirewall , BaseGenericFirewall , BaseGenericFirewallRule , CheckpointFirewall , CheckpointFirewallRule , UserDefinedSubnet , KubernetesService , UserDefinedProblemEvent , FirewallRuleMaskEvent , EdgeDevice , RouterDevice , NSXController , LogicalRouter , NSXTManagementNode , NSXTController , NSXTTransportNode , NSXTTransportZone , NSXTLoadBalancer , NSXTVirtualServer , NSXTServerPool , NSXTLogicalSwitch , NSXTRouterDevice , NSXTEdgeCluster , NSXControllerCluster , AzureSubscription , AWSAccountManager , HcxDataSource , VMCSDDC , VMCCapacityThresholdBreachEvent , PolicyManagerSegment , PolicyManagerFirewallSection , DirectConnectInterface
query filter
Authentication
Response
Response BodyResponse Body
200 OK
{
"cursor": "MTA=",
"total_count": 1000
}
Cursor for the next page
Total count of objects returned
Errors
Bad Request
Unauthorized
Internal Error
