Loading TOC...

MarkLogic Server 11.0 Product Documentation
GET /manage/v2/meters/resources

Summary

This resource address returns a list of all of the resources in the local cluster that existed in specified time period.. Note that using the start and end parameters to define a time range may be expensive.

URL Parameters
format The format of the returned data. Can be either json (default) or xml. This value overrides the Accept header if both are present.
period The frequency of the returned data. A value of raw returns the resources just as they were captured with the set frequency. A value of hour returns the resources once per hour (this is the default). A value of day returns the resources once per day.
start Return the resource list, starting at this timestamp (in the form of dateTime).
end Return the resource list, ending at this timestamp (in the form of dateTime).
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 application/xml or application/json.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data.

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 data in the response body is as follows:

current-time

The timestamp for when the view was generated.

start

end

cluster

This is a complex structure with the following children:

cluster-id

name

group

This is a complex structure with the following children:

group-id

name

host

This is a complex structure with the following children:

cluster-id

group-id

host-id

name

forest

This is a complex structure with the following children:

cluster-id

group-id

host-id

forest-id

name

database

This is a complex structure with the following children:

cluster-id

group-id

host-id

database-id

name

forests-ids

This is a complex structure with the following children:

forest-id

server

This is a complex structure with the following children:

cluster-id

group-id

host-id

server-id

name

type

Example


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

==> Returns the list resources in the cluster.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.