Data Metrics Server REST API Reference

UnboundID Logo

/instances

GET

Available Since: 3.6

Query for a set of product instances. The returned ProductInstances correspond to servers that the metrics engine has polled for data.

Parameters

name description type default
instanceType The product instance types to match. If not specified all instance types are matched. 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
instanceGroup The product instance groups to match. If not specified all instance groups are matched. This parameter is currently not implemented. query
instanceLocation The product instance locations to match. If not specified all instance locations are matched. To match more than one location, specify this parameter multiple times. Valid locations are contained in the location attribute of the result from resource InstancesResource. query
instanceHostname The product instance hostnames to match. If not specified all instance hostnames are matched. To matched more than one hostname, specify this parameter multiple times. Valid hostnames are contained in the hostname attribute of the result from resource InstancesResource. query
instanceVersion The product instance versions to match or null to match all instance versions. Valid version strings are contained in the version attribute of the result from resource InstancesResource. 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: productInstancesResponse
media types: application/xml
application/json

The ProductInstancesResponse with the product instances that matched the criteria.

Status Codes

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