This resource address returns status information about the forests in the cluster.
Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data.
manage-user
role, or the following
privilege: http://marklogic.com/xdmp/privileges/manage
The structure of the output returned from this REST API is as follows:
meta
This is a complex structure with the following children:
uri
current-time
elapsed-time
start-min
view-error
This is a complex structure with the following children:
error-type
error-name
error-code
error-message
relations
This is a complex structure with the following children:
relation-group
This is a complex structure with the following children:
uriref
typeref
roleref
relation-count
relation
This is a complex structure with the following children:
qualifiers
This is a complex structure with the following children:
qualifier
This is a complex structure with the following children:
uriref
typeref
idref
nameref
uriref
typeref
roleref
idref
nameref
status-list-summary
This is a complex structure with the following children:
total-forests
state-not-open
max-stands-per-forest
merge-count
backup-count
restore-count
min-capacity
load-properties
This is a complex structure with the following children:
total-load
load-detail
This is a complex structure with the following children:
query-read-load
journal-write-load
save-write-load
merge-read-load
merge-write-load
backup-read-load
backup-write-load
restore-read-load
restore-write-load
large-read-load
large-write-load
database-replication-send-load
database-replication-receive-load
read-lock-wait-load
read-lock-hold-load
write-lock-wait-load
write-lock-hold-load
deadlock-wait-load
rate-properties
This is a complex structure with the following children:
total-rate
rate-detail
This is a complex structure with the following children:
query-read-rate
journal-write-rate
save-write-rate
merge-read-rate
merge-write-rate
backup-read-rate
backup-write-rate
restore-read-rate
restore-write-rate
large-read-rate
large-write-rate
database-replication-send-rate
database-replication-receive-rate
read-lock-rate
write-lock-rate
deadlock-rate
cache-properties
This is a complex structure with the following children:
list-cache-hit-rate
list-cache-miss-rate
triple-cache-hit-rate
triple-cache-miss-rate
triple-value-cache-hit-rate
triple-value-cache-miss-rate
compressed-tree-cache-hit-rate
compressed-tree-cache-miss-rate
list-cache-ratio
triple-cache-ratio
triple-value-cache-ratio
compressed-tree-cache-ratio
large-binary-cache-hit-rate
large-binary-cache-miss-rate
status-list-items
This is a complex structure with the following children:
status-list-item
This is a complex structure with the following children:
uriref
idref
nameref
related-views
This is a complex structure with the following children:
related-view
This is a complex structure with the following children:
view-type
view-name
view-uri
http://localhost:8002/manage/v2/forests?view=status ==> Returns a status summary of the forests in the cluster.
http://localhost:8002/manage/v2/forests?view=status&database-id=Documents ==> Returns a status view of the forests in the Documents database.