v1

latestOpenAPI 3.0.12026-07-17221165.2 KB
PMAPI HOST SERVICES

Provides detailed PMAPI metric metadata

The metric endpoint provides detailed PMAPI metric metadata for one or more metrics. If no parameters are supplied, the response will be for all metrics found when traversing the entire Performance Metrics Name Space (PMNS).

The prefix parameter can be used to specify a subtree of the PMNS for traversal. Alternatively, a specific metric or comma-separated list of metrics can be specified using either name or names.

The server response is a JSON document that provides metric metadata as an array.

$ curl -s http://localhost:44322/pmapi/metric?names=kernel.all.load,disk.all.read | pmjson

Most of the fields are directly transcribed from the PMAPI calls for metric descriptors, labels and help text mentioned above and are exactly as would be observed using the pminfo(1) command with the - dlmstT options.

The semantics, type and units fields are as returned by pmTypeStr(3), pmUnitsStr(3) and pmSemStr(3).

Reference: pmLookupDesc(3), pmLookupLabels(3), pmLookupName(3), pmLookupText(3)

get/pmapi/metric

Query parameters

namestring

An individual metric name

namesstring

Comma-separated list of metric names

{"stackTrail":"paths:/pmapi/metric:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Numeric or pmIDStr(3) metric identifier

pmidsstring

Comma-separated numeric or pmIDStr(3) pmIDs

prefixstring

Metric namespace component as in PMNS(5)

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