MarkLogic 10 Product Documentation
GET /manage/v2/hosts?view=metricsSummary
Retrieve historical monitoring data about the hosts in the cluster.
URL Parameters |
format |
The format of the returned data. Can be either
html , json , or xml (default). This value overrides
the Accept header if both are present. |
group-id |
Specifies to return only the hosts in the
specified group. The group can be identified either by id or name. |
Request Headers |
Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
Response Headers |
Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml , application/json , or text/html .
|
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response
body contains the requested information.
Required Privileges
This operation requires the
manage-user
role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
meta
metrics-properties
metrics-relations
related-views
Example
http://localhost:8002/manage/v2/hosts?view=metrics
==> Returns historical monitoring data for the hosts in the cluster.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.