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

Search

Description

Using search QL API you can execute search by specifying search query directly as you specify on the UI. A successful search execution will return one of the following three things :

  1. List of entity ids that matches the search criteria.
  2. List of aggregations.
  3. List of groups.

Request

Request

URL

URL


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

Request Body

Request Body

SearchQueryRequest of type(s) application/json Optional

Search Query Request

{
	"cursor": "MTA=",
	"query": "VMs group by Application",
	"size": 10,
	"time_range": {
		"end_time": 1597247999,
		"start_time": 1597247025
	}
}
string
cursor Optional

string
query Optional

Query


integer as int32
size Optional

Page size of results


time_range Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns SearchQueryResponse of type(s) application/json
{
	"aggregation_response": [
		{
			"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
		}
	],
	"entity_list_response": [
		{
			"cursor": "ML12eu02==",
			"end_time": 1504739809,
			"results": [
				{
					"entity_id": "string",
					"entity_type": "VirtualMachine",
					"time": 0
				}
			],
			"start_time": 1504739809,
			"total_count": 100
		}
	],
	"groupby_response": [
		{
			"cursor": "MTA=",
			"results": [
				{
					"aggregations": [
						{
							"aggregation_type": "SUM",
							"field": "string",
							"value": 0
						}
					],
					"bucket": [
						{
							"field": "string",
							"value": "string"
						}
					],
					"count": 100,
					"series_values": [
						{
							"aggregation_type": "SUM",
							"field": "string",
							"resolution_in_secs": 0,
							"series": [
								0
							]
						}
					]
				}
			],
			"size": 0,
			"time_range": {
				"end_time": 1597247999,
				"start_time": 1597247025
			},
			"total_bucket": {
				"is_approx": false,
				"value": 0
			},
			"total_count": 1000
		}
	],
	"search_response_total_hits": 100
}
aggregation_response Optional

entity_list_response Optional

groupby_response Optional

integer as int32
search_response_total_hits Optional

Total number of results

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 '{"cursor":"MTA=","query":"VMs group by Application","size":10,"time_range":{"end_time":1597247999,"start_time":1597247025}}' https://vrni.example.com/api/ni/search/ql


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

Was this page helpful?