[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Search
DescriptionUsing 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 :
- List of entity ids that matches the search criteria.
- List of aggregations.
- List of groups.
Request
URLURL
https://vrni.example.com/api/ni/search/ql
Request Body
Request Body
{
"cursor": "MTA=",
"query": "VM where CPU Cores > 2",
"size": 10,
"time_range": {
"end_time": 1534410559,
"start_time": 1534410000
}
}
string
cursor
Optional
string
query
Optional
Query
integer as int32
size
Optional
Page size of results
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
SearchQueryResponse
of type(s) application/json
{
"search_response_total_hits": 100
}
integer as int32
search_response_total_hits
Optional
Total number of results
Errors
ApiError
400
Bad Request
401
Unauthorized
500
Internal Error
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"cursor":"MTA=","query":"VM where CPU Cores > 2","size":10,"time_range":{"end_time":1534410559,"start_time":1534410000}}' https://vrni.example.com/api/ni/search/ql
[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
