Sign in

v1

latestOpenAPI 3.0.12026-07-17221165.2 KB
PMAPI HOST SERVICES

Lists the current instances of an instance domain

This request lists the current instances of an instance domain. The instance domain is either specified directly (in numeric or string form) or indirectly, by association with the specified metric.

The request can be further qualified with a comma-separated list of the instances to report on, either by name or number, using the instance and iname parameters.

In the case of instance name qualifiers, these will be matched by exact string comparison by default. Alternatively, the match parameter can be used to specify that regular expression or glob pattern matching should be used instead.

The response is a JSON document that provides the instance domain metadata as an array.

$ curl -s http://localhost:44322/pmapi/indom?name=kernel.all.load | pmjson

Reference: pmGetInDom(3), pmNameInDom(3), pmLookupInDom(3)

get/pmapi/indom

Query parameters

inamestring

Comma-separated list of instance names

{"stackTrail":"paths:/pmapi/indom:get:parameters:1:schema","oasType":"schema","type":"unknown"}

Numeric or pmInDomStr(3) instance domain

instancenumber

Comma-separated list of instance numbers

matchstring

Pattern matching style (exact, glob or regex)

namestring

An individual metric name

hostspecstring

Host specification as described in PCPIntro(1)

contextnumber

Web context number (optional like hostspec)

polltimeoutnumber

Seconds of inactivity before closing context

clientstring

Request identifier sent back with response

Response

OK