/metrics

GET

Available Since: 3.6

List an query for a set of com.unboundid.directory.mon.api.v1.models.Metrics. The returned Metric objects include meta data about the metric, including its name, description, types of servers that produce the metric, dimensions the metric supports and valid values for each dimension.

Parameters

name	description	type	default
name	Limits the results to metrics whose names contain a matching substring. The search is not case-sensitive.	query
type	Limits the results to metrics of the specified types. A list of valid metric types will be returned in an error message if an invalid type is specified.	query
group	Limits the result to metrics of the specified groups. A list of valid metric groups will be returned in an error message if an invalid group is specified.	query
instanceType	Limits the result to metrics that are produced by the specified instance types. If not specified all instance types are used. To match more than one instance type, specify this parameter multiple times. A list of valid instance types will be returned in an error message if an invalid value is provided.	query
statistic	Limits the results to metrics that support the specified statistics. A list of valid statistics will be returned in an error message if an invalid statistic is specified.	query
limit	Specifies how many results should be returned. The default is to return all results. This is used in conjunction with the offset parameter to page through a large result set.	query	0
offset	Specifies how many results to skip for the first returned result. This is used in conjunction with the limit parameter to page through a large result set.	query	0

Response Body

result:	metricsResponse
media types:	application/xml application/json

The metrics result as an MetricsResponse.

Status Codes

code	description
200 OK	Success
400 Bad Request	Invalid parameter
500 Internal Server Error	Internal error