Sign in

v1

latestOpenAPI 3.0.12026-07-17221165.2 KB
FULL TEXT SEARCH

Performs a text search query

It performs a text search query across metrics and instance domains - all forms of names and help texts.

The mandatory search string is further described in pmsearch(1) and is passed to the server via the query parameter (HTTP GET).

$ curl -s http://localhost:44322/search/text?query=halt | pmjson

The available search entity types are metric, indom and instance. Query parameters highlight and field take name, oneline and helptext.

Query parameter return takes name, type, oneline, helptext, indom. There is typically both a name and help text associated with metrics. Contents of these are then matched against query. An instance domain has help text and a numeric identifier, while instances have a name only (which can be searched).

Reference: pmSearchTextQuery(3)

get/search/text

Query parameters

querystring

Query string in pmsearch(1) format

{"stackTrail":"paths:/search/text:get:parameters:1:schema","oasType":"schema","type":"unknown"}

Include matching markup in response fields

offsetnumber

Result offset cursor for pagination

limitnumber

Maximum results to include in response

{"stackTrail":"paths:/search/text:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Queried fields (defaults to all)

{"stackTrail":"paths:/search/text:get:parameters:5:schema","oasType":"schema","type":"unknown"}

Fields to actually return (defaults to all)

{"stackTrail":"paths:/search/text:get:parameters:6:schema","oasType":"schema","type":"unknown"}

Entity types to filter (defaults to all)

Response

OK