MarkLogic Server 11.0 Product Documentation
GET /manage/v2/forestsSummary
This resource address returns data about the forests in the cluster. The data
returned depends on the view. If no view is specified, this request
returns a summary of the forests in the cluster.
| URL Parameters |
| format |
The format of the returned data. Can be either
json, or xml. This value overrides the Accept header if both are
present. |
| view |
A specific view of the returned data. Can be either
schema, counts, storage, metrics,
default, or status. |
| database-id |
Returns a summary of the forests for the
specified database. The database can be identified either by id or name. |
| group-id |
Returns a summary of the forests for the
specified group. The group can be identified either by id or name. |
| host-id |
Returns a summary of the forests for the specified
host. The host can be identified either by id or name. |
| fullrefs |
If set to true, full detail is
returned for all relationship references. A value of false (the default)
indicates to return detail only for first references. |
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header.
Supported values: application/xml, application/json,
text/html. |
| 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). 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 for the default view is as follows:
metaProperties of the view rather than the resource.
This is a complex structure with the following children:
uriThe path to the view.
current-timeThe timestamp for when the view was generated.
elapsed-timeThe time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-minThe timestamp for filtering out more recent
requests or transactions.
view-errorAn error limiting the data in the view.
This is a complex structure with the following children:
error-typeThe kind of error.
error-nameThe name of the error.
error-codeThe error identifier.
error-messageThe error text.
relationsRelationships to resources.
This is a complex structure with the following children:
relation-groupRelated resources with the same type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
relation-countThe number of related resources.
relationA specific related resource.
This is a complex structure with the following children:
qualifiersA list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifierAnother resource that qualifies the resource.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
list-itemsItems of this resource type.
This is a complex structure with the following children:
list-countThe number of items of this resource type.
list-itemAn item of this resource type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
item-summary
related-viewsA list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-viewA broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-typeThe kind of view.
view-nameThe name of the view.
view-uriThe path for the view.
Example
http://localhost:8002/manage/v2/forests
==> Returns a summary of the forests in the cluster.
Example
http://localhost:8002/manage/v2/forests?view=storage
==> Returns a storage view of the forests in the cluster.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.