Loading TOC...

GET /manage/v2?view=status

Summary

This resource address returns a status summary for the local cluster.

URL Parameters
format The format of the returned data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
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, 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:

id

A cluster ID.

name

A cluster name.

version

The version of the product.

effective-version

The effective software version of this cluster.

role

The role (local or foreign ) of the cluster in the current environment.

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.

status-relations

This is a complex structure with the following children:

hosts-status

Status of hosts for the cluster.

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.

hosts-status-summary

Summary for the cluster hosts.

This is a complex structure with the following children:

total-hosts

The total number of hosts.

load-properties

The load properties of the cluster forests or hosts.

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 cluster forests or hosts.

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.

external-binary-read-load

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

xdqp-client-receive-load

The moving average of the receive load for the xdqp client, in seconds per second. This is summed for all of the contributing threads.

xdqp-client-send-load

The moving average of the send load for the xdqp client, in seconds per second. This is summed for all of the contributing threads.

xdqp-server-receive-load

The moving average of the receive load for the xdqp server, in seconds per second. This is summed for all of the contributing threads.

xdqp-server-send-load

The moving average of the send load for the xdqp server, in seconds per second. This is summed for all of the contributing threads.

foreign-xdqp-client-receive-load

The moving average of the receive load for the xdqp client, in seconds per second. This is summed for all of the contributing threads.

foreign-xdqp-client-send-load

The moving average of the send load for the xdqp client, in seconds per second. This is summed for all of the contributing threads.

foreign-xdqp-server-receive-load

The moving average of the receive load for the xdqp server, in seconds per second. This is summed for all of the contributing threads.

foreign-xdqp-server-send-load

The moving average of the send load for the xdqp server, in seconds per second. This is summed for all of the contributing threads.

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 cluster forests or hosts.

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 cluster forests or hosts.

This is a complex structure with the following children:

memory-process-swap-rate

The swap rate for the MarkLogic process in pages/sec.

memory-system-pagein-rate

The page in rate for the system in pages/sec.

memory-system-pageout-rate

The page out rate for the system in pages/sec.

memory-system-swapin-rate

The swap in rate for the system in pages/sec.

memory-system-swapout-rate

The swap out rate for the system in pages/sec.

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.

external-binary-read-rate

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

xdqp-client-receive-rate

The moving average of receiving xdqp client messages, in megabytes per second.

xdqp-client-send-rate

The moving average of sending xdqp client messages, in megabytes per second.

xdqp-server-receive-rate

The moving average of receiving xdqp server messages, in megabytes per second.

xdqp-server-send-rate

The moving average of sending xdqp server messages, in megabytes per second.

foreign-xdqp-client-receive-rate

The moving average of receiving xdqp client messages, in megabytes per second.

foreign-xdqp-client-send-rate

The moving average of sending xdqp client messages, in megabytes per second.

foreign-xdqp-server-receive-rate

The moving average of receiving xdqp server messages, in megabytes per second.

foreign-xdqp-server-send-rate

The moving average of sending xdqp server messages, 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.

servers-status

Status of servers for the cluster.

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.

servers-status-summary

Summary for the cluster servers.

This is a complex structure with the following children:

request-rate

The rate of a request (requests/sec).

expanded-tree-cache-miss-rate

The average number of misses on the expanded cache.

expanded-tree-cache-hit-rate

The average number of hits on the expanded cache.

request-count

The total number of requests for the cluster.

forests-status

Status of forests for the cluster.

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.

forests-status-summary

Summary for the cluster forests.

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.

cache-properties

The cache properties for the forests.

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.

requests-status

Status of requests for the cluster.

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.

requests-status-summary

Summary for the cluster requests.

This is a complex structure with the following children:

specified-seconds-min

The minimum number of seconds specified to qualify the list of requests or transactions.

max-seconds

The maximum length in seconds for the active requests.

ninetieth-percentile-seconds

The length in seconds for the ninetieth percentile of the active requests.

median-seconds

The median length in seconds for the active requests or the open transactions.

mean-seconds

The mean length in seconds for the active requests or the open transactions.

standard-dev-seconds

The standard deviation in seconds for the active requests or the open transactions.

min-seconds

The minimum length in seconds for the active requests or the open transactions.

total-requests

The total number of active requests.

update-count

The total number of active update requests.

query-count

The total number of active query requests.

transactions-status

Status of transactions for the cluster.

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.

transactions-status-summary

Summary for the cluster transactions.

This is a complex structure with the following children:

specified-seconds-min

The minimum number of seconds specified to qualify the list of requests or transactions.

max-seconds

The maximum length in seconds for the active requests.

ninetieth-percentile-seconds

The length in seconds for the ninetieth percentile of the active requests.

median-seconds

The median length in seconds for the active requests or the open transactions.

mean-seconds

The mean length in seconds for the active requests or the open transactions.

standard-dev-seconds

The standard deviation in seconds for the active requests or the open transactions.

min-seconds

The minimum length in seconds for the active requests or the open transactions.

total-transactions

The total number of open transactions.

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

  ==>  Returns a status summary information for the local cluster. 
    

Comments

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