Loading TOC...

GET /manage/v2/meters

Summary

This resource address lists all existing meters with descriptions and units, including cluster-id and host-id.

URL Parameters
format The format of the returned data. Can be either json (default) or xml or html. This value overrides the Accept header if both are present.
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, either text/html, application/xml or application/json.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 (Not Found) is returned if the page cannot be found.

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:

meters:cluster-id

meters:group-id

meters:host-id

meters:cluster-name

meters:group-name

meters:host-name

Example


http://localhost:8002/manage/v2/meters

==> Returns all of the metrics. 
    

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy