MarkLogic Server 11.0 Product Documentation
GET /manage/v2/forests?view=storage

Summary

This resource address returns storage information about 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.
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 output returned from this REST API is as follows:

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The 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-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

storage-list-items

The list of hosts that have storage for forests.

This is a complex structure with the following children:

storage-host

A host that has storage for forests.

This is a complex structure with the following children:

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

relation-id

A resource related to the host.

locations

The list of locations on the host that have forests.

This is a complex structure with the following children:

location

A location on the host that has forests.

This is a complex structure with the following children:

path

The path of the stand.

capacity

The percentage of storage space that is free.

device-space

The amount of space left on forest device.

fast-forest-size

The total fast storage for forests in MB.

forest-reserve

The amount of space needed for merging.

forest-size

The total ordinary storage for forests in MB.

large-data-size

The amount of space large objects take up on disk.

remaining-space

The total free storage for forests in MB.

location-forests

The list of forests at the location on the host.

This is a complex structure with the following children:

location-forest

A forest at the location on the host.

This is a complex structure with the following children:

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

relation-id

A resource related to the host.

uriref

The path for a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

disk-size

The amount of space the stand takes on disk.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example


http://localhost:8002/manage/v2/forests?view=storage

==>  Returns a storage summary of the forests in the cluster.
Powered by MarkLogic Server | Terms of Use | Privacy Policy