Loading TOC...

GET /manage/v2/forests?view=status

Summary

This resource address returns status 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.

status-list-summary

Status summary for the forests in the list.

This is a complex structure with the following children:

total-forests

The total number of forests.

state-not-open

The number of forests that aren't open.

max-stands-per-forest

The maximum number of stands for a forest.

merge-count

The maximum number of forests that are merging.

backup-count

The maximum number of forests that are backing up.

restore-count

The maximum number of forests that are restoring.

min-capacity

The least capacity for a forest as a percentage.

load-properties

The load properties of the forest.

This is a complex structure with the following children:

total-load

The sum of the processing load factors in seconds per second.

load-detail

The detailed load characteristics for the forest.

This is a complex structure with the following children:

query-read-load

The moving average of the read load on the query, in seconds per second. This is summed for all of the contributing threads.

journal-write-load

The moving average of the load for writing to the journal, in seconds per second. This is summed for all of the threads writing on the host.

save-write-load

The moving average of the load for writing to in-memory stands, in seconds per second. This is summed for all of the threads writing on the host.

merge-read-load

The moving average of the read load on the merge, in seconds per second. This is summed for all of the contributing threads.

merge-write-load

The moving average of the load for writing for merges, in seconds per second. This is summed for all of the threads writing on the host.

backup-read-load

The moving average of the read load on the backup, in seconds per second. This is summed for all of the contributing threads.

backup-write-load

The moving average of the load for writing for backups, in seconds per second. This is summed for all of the threads writing on the host.

restore-read-load

The moving average of the read load on the backup, in seconds per second. This is summed for all of the contributing threads.

restore-write-load

The moving average of the load for writing for restores, in seconds per second. This is summed for all of the threads writing on the host.

large-read-load

The moving average of the read load on large documents, in seconds per second.

large-write-load

The moving average of the load for writing for large documents, in seconds per second.

database-replication-send-load

The moving average of the load for sending data for database replication, in seconds per second.

database-replication-receive-load

The moving average of the load for receiving data for database replication, in seconds per second.

read-lock-wait-load

The read lock wait load, summed across all forests on the host.

read-lock-hold-load

The read lock hold load, summed across all forests on the host.

write-lock-wait-load

The write lock wait load, summed across all forests on the host.

write-lock-hold-load

The write lock hold load, summed across all forests on the host.

deadlock-wait-load

The deadlock wait load, summed across all forests on the host.

rate-properties

The rate properties of the forest.

This is a complex structure with the following children:

total-rate

The sum of the processing rate factors in seconds per second.

rate-detail

The detailed rate characteristics for the forest.

This is a complex structure with the following children:

query-read-rate

The moving average of reading query data from disk, in megabytes per second.

journal-write-rate

The moving average of writing data to the journal, in megabytes per second.

save-write-rate

The moving average of writing data to in-memory stands, in megabytes per second.

merge-read-rate

The moving average of reading merge data from disk, in megabytes per second.

merge-write-rate

The moving average of writing data for merges, in megabytes per second.

backup-read-rate

The moving average of reading backup data from disk, in megabytes per second.

backup-write-rate

The moving average of writing data for backups, in megabytes per second.

restore-read-rate

The moving average of reading restore data from disk, in megabytes per second.

restore-write-rate

The moving average of writing data for restores, in megabytes per second.

large-read-rate

The moving average of reading large documents from disk, in megabytes per second.

large-write-rate

The moving average of writing data for large documents, in megabytes per second.

database-replication-send-rate

The moving average of sending data for database replication, in megabytes per second.

database-replication-receive-rate

The moving average of receiving data for database replication, in megabytes per second.

read-lock-rate

The rate of taking read locks, summed across all forests on the host.

write-lock-rate

The rate of taking write locks, summed across all forests on the host.

deadlock-rate

The rate of taking write locks, summed across all forests on the host.

cache-properties

The cache properties of the forest.

This is a complex structure with the following children:

list-cache-hit-rate

The average number of hits on the list cache.

list-cache-miss-rate

The average number of misses on the list cache.

triple-cache-hit-rate

The average number of hits on the list cache.

triple-cache-miss-rate

The average number of misses on the list cache.

triple-value-cache-hit-rate

The average number of hits on the list cache.

triple-value-cache-miss-rate

The average number of misses on the list cache.

compressed-tree-cache-hit-rate

The average number of hits on the compressed cache.

compressed-tree-cache-miss-rate

The average number of misses on the compressed cache.

list-cache-ratio

triple-cache-ratio

triple-value-cache-ratio

compressed-tree-cache-ratio

large-binary-cache-hit-rate

The average number of hits on the large binary cache.

large-binary-cache-miss-rate

The average number of misses on the large binary cache.

status-list-items

The forests reflected in the status summary.

This is a complex structure with the following children:

status-list-item

A forest reflected in the status summary.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

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=status

==>  Returns a status summary of the forests in the cluster. 
    

Example


http://localhost:8002/manage/v2/forests?view=status&database-id=Documents

==>  Returns a status view of the forests in the Documents database. 
    

Comments

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