Search Entities
DescriptionUsing search API you can search vRealize Network Insight entities by specifying entity type and filter expression. A filter expression is a predicate expression (similar to SQL where clause) used to define the search criteria. Please refer to API Guide on details of how to construct filter expression. A successful search request will return a list of entity ids that matches the search criteria.
Request
URLURL
Request Body
{
"cursor": "string",
"entity_type": "Group",
"filter": "string",
"size": 0,
"sort_by": {
"field": "string",
"order": "ASC"
},
"time_range": {
"end_time": 1597247999,
"start_time": 1597247025
}
}
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": "ML12eu02==",
"end_time": 1504739809,
"start_time": 1504739809,
"total_count": 100
}
Cursor for the next page
End timestamp of the window of the objects returned
Start timestamp of the window of the objects returned
Total number of objects returned
Errors
Bad Request
Unauthorized
Internal Error
