NSX-T Data Center REST API

AdditionalSearchParameters (schema) (Experimental)

Represents search object that provides additional search capabilities

This object presents additional search capabilities over any API through free text query string. e.g. query="Web-VM-1".

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
dsl Search DSL (domain specific language) query

It's human readable and context-based query language for retreiving
information from search indices.
For example: Find router where ip is 10.10.1.10
string
included_fields Comma separated list of fields that should be included in query result

Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.
string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
query Search query string
sort_ascending boolean
sort_by Field by which records are sorted string