Loading TOC...

GET /manage/v2/databases/{id|name}?view=status

Summary

This resource address returns status information for the named database. The database can be identified either by id or name.

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), and the response body contains the requested data. If the URI is malformed or the database doesn't exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

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

name

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-properties

The operating characteristics of the database.

This is a complex structure with the following children:

enabled

Whether the trigger is enabled or not.

state

The state of the database.

indexing-state

Whether the database attached forests are indexing.

rebalancing-state

Whether the database attached forests are rebalancing.

forests-count

The number of forests for the database.

device-space

The amount of space left on the device.

data-size

The total size of the database on disk.

large-data-size

The total size of the large data on disk.

fast-data-size

The total size of the fast storage on disk.

in-memory-size

The total memory used for the database.

merge-count

The maximum number of forests that are merging.

total-merge-size

The total size of active forest merging for the database.

reindex-count

The total number of reindexing forests for the database.

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.

rebalancing

load-properties

The load properties of the database.

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 database.

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 database.

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 database.

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 database.

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.

local-disk-failover

The failover properties of the database.

This is a complex structure with the following children:

local-disk-failover-active

Whether the database has failover to forests on the local disk.

replicas

The number of the forests for failover to the local disk.

replica-on-disk-size

The total size on disk of the forests for failover to the local disk.

replica-in-memory-size

The total size in memory of the forests for failover to the local disk.

failed-masters

The total number of replica forests for failover to the local disk.

active-replicas

The total number of forests that are actively replicating for failover to the local disk.

async-replicating

The total number of forests that are async replicating for failover to the local disk.

wait-replication

The total number of forests that are waiting to replicate for failover to the local disk.

database-replication-status

The database replication properties of the database.

This is a complex structure with the following children:

database-replication-configured

Whether database replication is configured.

database-replication-active

Whether all forests are replicating to corresponding forests.

local-forests

Count of local forests

is-foreign-replica

Whether the local forest is a replica of a foreign forest.

foreign-replica-databases

Count of configured foreign replica databases.

foreign-replica-forests

Count of foreign replica forests.

foreign-forests-lag-exceeded

Count of foreign forests where reported lag exceeds configured lag.

flexible-replication-enabled

Whether flexible replication is enabled.

cpf-enabled

Whether CPF (the Content Processing Framework) is enabled.

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

==> Returns status information on the Documents database.
    

Comments

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