Loading TOC...

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

Summary

This resource address returns status information on a specific host. The host 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.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The possible fields in the output are shown below. In general, all the fields are optional. Any field might be missing from the result set if it does not have a value.

A valid license key is required to use the reverse index and the REST API features. This license is included as part of the base server license for many, but not all, MarkLogic licenses. Verify the licensed features for your license in Host Status in the Admin GUI.

id

A host unique id (64-bit value).

name

The name of the Host

version

The version of the product.

effective-version

The effective software version of this host

host-mode

Mode of this host

host-mode-description

The description for this host mode

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

Operating characteristics of the host.

This is a complex structure with the following children:

online

Is this host seen as online? (true for online)

error

The error in processing forest status.

secure

Is communication secured with SSL? For the local host, this is always false.

cache-properties

The cache status properties of the host.

This is a complex structure with the following children:

cache-detail

This is a complex structure with the following children:

compressed-tree-cache-partitions

The compressed-tree cache partitions.

This is a complex structure with the following children:

compressed-tree-cache-partition

The compressed-tree cache partition.

This is a complex structure with the following children:

partition-size

The size of a cache partition, in megabytes.

partition-table

The percentage of the table for a cache partition that is currently used.

partition-used

The percentage of the space in a cache partition that is currently used.

partition-free

The percentage of the space in a cache partition that is currently free.

partition-overhead

The percentage of the space in a cache partition that is currently overhead.

expanded-tree-cache-partitions

The expanded-tree cache partitions.

This is a complex structure with the following children:

expanded-tree-cache-partition

The expanded-tree cache partition.

This is a complex structure with the following children:

partition-size

The size of a cache partition, in megabytes.

partition-table

The percentage of the table for a cache partition that is currently used.

partition-busy

The percentage of the space in a cache partition that is currently used and cannot be freed.

partition-used

The percentage of the space in a cache partition that is currently used.

partition-free

The percentage of the space in a cache partition that is currently free.

partition-overhead

The percentage of the space in a cache partition that is currently overhead.

triple-cache-partitions

The triple cache partitions.

This is a complex structure with the following children:

triple-cache-partition

The triple cache partition.

This is a complex structure with the following children:

partition-size

The size of a cache partition, in megabytes.

partition-busy

The percentage of the space in a cache partition that is currently used and cannot be freed.

partition-used

The percentage of the space in a cache partition that is currently used.

partition-free

The percentage of the space in a cache partition that is currently free.

triple-value-cache-partitions

The triple value cache partitions.

This is a complex structure with the following children:

triple-value-cache-partition

The triple value cache partition.

This is a complex structure with the following children:

partition-size

The size of a cache partition, in megabytes.

partition-busy

The percentage of the space in a cache partition that is currently used and cannot be freed.

partition-used

The percentage of the space in a cache partition that is currently used.

partition-free

The percentage of the space in a cache partition that is currently free.

value-count

The number of RDF values.

value-bytes-total

The total number of bytes used by RDF values.

value-bytes-average

The average number of bytes per RDF value.

load-properties

The load properties of the host.

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

This is a complex structure with the following children:

query-read-load

Disk reading time threads spent for a query in proportion to the elapsed time. This is a moving average summed for all of the contributing threads.

journal-write-load

Journal writing time threads spent in proportion to the elapsed time. This is summed for all of the threads writing on the host.

save-write-load

The moving average of time threads spent writing to in-memory stands, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

merge-read-load

Disk read time threads spent during merge, in proportion to the elapsed time. This is summed for all of the contributing threads.

merge-write-load

Disk writing time threads spent for merges, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

backup-read-load

Disk read time threads spent for backup, in proportion to the elapsed time. This is summed for all of the contributing threads.

backup-write-load

Disk writing time threads spent for backups, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

restore-read-load

Disk read time threads spent for restores, in proportion to the elapsed time. This is summed for all of the contributing threads.

restore-write-load

Disk write time threads spent for restores, in proportion to the elasped time. This is summed for all of the threads writing on the host.

large-read-load

Disk read time threads spent on large documents, in proportion to the elapsed time.

large-write-load

Disk write time threads spent for large documents, in proportion to the elapsed time.

external-binary-read-load

Disk read time threads spent on external binary documents, in proportion to the elapsed time.

xdqp-client-receive-load

Time threads spent receiving data for the xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-client-send-load

Time threads spent sending data for xdqp clients, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-receive-load

Time threads spent receiving data for the xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-send-load

Time threads spent sending data for the xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-client-receive-load

Time threads spent receiving data for the foreign xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-client-send-load

Time threads spent sending data for the foreign xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-server-receive-load

Time threads spent receiving data for the foreign xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-server-send-load

Time threads spent sending data for the foreign xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

read-lock-wait-load

Time threads spent waiting to acquire read locks in proportion to the elasped time, summed across all forests on the host.

read-lock-hold-load

Time threads spent holding read locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-wait-load

Time threads spent waiting to acquire write locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-hold-load

Time threads spent holding write locks in proportion to the elapsed time, summed across all forests on the host.

deadlock-wait-load

Time threads spent waiting for locks that eventually result in deadlocks in proportion to the elasped time, summed across all forests on the host.

rate-properties

The rate properties of the host.

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

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 throughput 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 throughput of reading merge data from disk, in megabytes per second.

merge-write-rate

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

backup-read-rate

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

backup-write-rate

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

restore-read-rate

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

restore-write-rate

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

large-read-rate

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

large-write-rate

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

external-binary-read-rate

Disk read throughput of external binary documents, in megabytes per second.

xdqp-client-receive-rate

The moving average throughput of the XDQP client receiving data, in megabytes per second.

xdqp-client-send-rate

The moving average throughput of the xdqp clients sending data, in megabytes per second.

xdqp-server-receive-rate

The moving average throughput of the xdqp server receiving data, in megabytes per second.

xdqp-server-send-rate

The moving average throughput of the xdqp server sending data, in megabytes per second.

foreign-xdqp-client-receive-rate

The moving average throughput of the foreign xdqp client receiving data, in megabytes per second.

foreign-xdqp-client-send-rate

The moving average throughput of the foreign xdqp client sending data, in megabytes per second.

foreign-xdqp-server-receive-rate

The moving average throughput of the foreign xdqp server receiving data, in megabytes per second.

foreign-xdqp-server-send-rate

The moving average throughput of the foreign xdqp server sending data, in megabytes per second.

read-lock-rate

The rate of read lock acquistions, summed across all forests on the host.

write-lock-rate

The rate of write lock acquistions, summed across all forests on the host.

deadlock-rate

The rate of deadlock occurrances, summed across all forests on the host.

status-detail

The detailed status characteristics for the host.

This is a complex structure with the following children:

error

The error in processing forest status.

zone

Zone the host belongs to.

bind-port

The distributed protocol server socket bind internet port number.

connect-port

The distributed protocol client socket connect internet port number.

ssl-fips-enabled

Is ssl fips mode enabled for this host?

foreign-bind-port

The distributed protocol server socket bind internet port number.

foreign-connect-port

The distributed protocol client socket connect internet port number.

background-io-limit

A rate limit for background I/O (MB/s, 0 means no limit).

metering-enabled

Metering Enabled

meters-database

The ID of the Meters database.

performance-metering-enabled

Monitoring Enabled

performance-metering-period

Monitor period in seconds

performance-metering-retain-raw

Retain raw monitoring data in days

performance-metering-retain-hourly

Retain hourly monitoring data in days

performance-metering-retain-daily

Retain daily monitoring data in days

last-startup

The timestamp of last host startup

version

The version of the product.

effective-version

The effective software version of this host

software-version

The actual software version of this cluster.

os-version

The host OS Platform and version description.

converters-version

The version of MarkLogic Converters on this host.

host-mode

Mode of this host

host-mode-description

The description for this host mode

architecture

The achitecture of the product.

platform

The platform of the product.

license-key

The license key for this host.

licensee

The host licensee.

license-key-expires

When does the license key for this host expire.

license-key-cpus

How many cpus does this license key support.

license-key-cores

How many cores does this license key support.

license-key-size

The database size (in MB) that this license key support.

license-key-options

The options that this host's license key provides.

This is a complex structure with the following children:

license-key-option

A license key option.

pre-release-expires

When does the pre-release for this host expire.

accepted-version

The last accepted version.

accepted-agreement

The last accepted agreement.

accepted-licensee

The last accepted licensee.

edition

The edition of this host.

environment

The environment of this host.

cpus

The number of CPUs.

cores

The number of cores.

core-threads

The number of core threads (including intel hyper threads).

total-cpu-stat-user

Total cpu utilization for user.

total-cpu-stat-nice

Total cpu utilization for nice.

total-cpu-stat-system

Total cpu utilization for system.

total-cpu-stat-idle

Total cpu utilization for idle.

total-cpu-stat-iowait

Total cpu utilization for iowait.

total-cpu-stat-irq

Total cpu utilization for irq.

total-cpu-stat-softirq

Total cpu utilization for softirq.

total-cpu-stat-steal

Total cpu utilization for steal.

total-cpu-stat-guest

Total cpu utilization for guest.

total-cpu-stat-guest-nice

Total cpu utilization for guest nice.

cpu-stat-user

Total cpu utilization for user.

cpu-stat-nice

Total cpu utilization for nice.

cpu-stat-system

Total cpu utilization for system.

cpu-stat-idle

Total cpu utilization for idle.

cpu-stat-iowait

Total cpu utilization for iowait.

cpu-stat-irq

Total cpu utilization for irq.

cpu-stat-softirq

Total cpu utilization for softirq.

cpu-stat-steal

Total cpu utilization for steal.

cpu-stat-guest

Total cpu utilization for guest.

cpu-stat-guest-nice

Total cpu utilization for guest nice.

memory-process-size

The number of MB of total process virtual memory for the MarkLogic process.

memory-process-rss

The number of MB of Process Resident Size (RSS) for the MarkLogic process.

memory-process-anon

The number of MB of Process Anonymous Memory for the MarkLogic process.

memory-process-rss-hwm

The maximum (High Water Mark) of Process Resident Size (RSS) in MB for the MarkLogic process.

memory-process-swap-rate

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

memory-process-swap-size

The number of MB of memory swapped out for the MarkLogic process.

memory-process-huge-pages-size

The size of huge pages for the MarkLogic process in MB. Available on Linux platform. Sum of Sizes after /anon_hugepage in /proc/[MLpid]/smaps

memory-system-total

The total system memory in MB. MemTotal from /proc/meminfo on Linux, m.ullTotalPhys from GlobalMemoryStatusEx(m) on Windows.

memory-system-free

The free system memory in MB. MemFree from /proc/meminfo on Linux, m.ullAvailPhys from GlobalMemoryStatusEx(m) on Windows.

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.

memory-size

The amount of space the stand takes in memory.

memory-file-size

The number of MB of virtual memory mapped to data files.

memory-forest-size

The number of MB of virtual memory used by forests.

memory-unclosed-size

The number of MB of virtual memory used by unclosed stands.

memory-cache-size

The number of MB of virtual memory used by caches.

memory-registry-size

The number of MB of virtual memory used to store registered queries.

memory-join-size

The number of MB of virtual memory used for join processing.

host-size

The total data size of all forests on the host. The size is calculated by adding the fast data directory size and the data directory size for each forest on this host, but it does not include any content stored in the large data directory.

host-large-data-size

The total size of all large binary data on the host.

log-device-space

The number of MB left on log device.

data-dir-space

The number of MB left on data dir.

backup-jobs

The backup jobs the host is processing.

This is a complex structure with the following children:

backup-job

The backup job.

This is a complex structure with the following children:

job-id

The unique ID of a job.

path

The path of the stand.

start-time

The time a merge started.

forests

The forests in a backup/restore job

This is a complex structure with the following children:

forest

A forest with id and status

This is a complex structure with the following children:

forest-id

The unique key of the forest.

status

restore-jobs

The restore jobs the host is processing.

This is a complex structure with the following children:

restore-job

The restore job.

This is a complex structure with the following children:

job-id

The unique ID of a job.

path

The path of the stand.

start-time

The time a merge started.

safe-restore-to-time

The safest timestamp closest to the restore-to-time at which the forest is in a consistent state.

forests

The forests in a backup/restore job

This is a complex structure with the following children:

forest

A forest with id and status

This is a complex structure with the following children:

forest-id

The unique key of the forest.

status

native-plugins

The native plugins loaded on a host.

This is a complex structure with the following children:

native-plugin

The status of a native plugin.

This is a complex structure with the following children:

path

The path of the stand.

version

The version of the product.

capabilities

The capabilities of a native plugin.

This is a complex structure with the following children:

aggregate

The name of an aggregate native plugin capability

lexer

The name of a lexer native plugin capability

stemmer

The name of a stemmer native plugin capability

query-read-bytes

The number of bytes read off disk.

query-read-time

The time (as xs:dayTimeDuration) to read query data from disk.

query-read-rate

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

query-read-load

Disk reading time threads spent for a query in proportion to the elapsed time. This is a moving average summed for all of the contributing threads.

journal-write-bytes

The number of bytes written to the journal on disk.

journal-write-time

The time (as xs:dayTimeDuration) to write data to the journal.

journal-write-rate

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

journal-write-load

Journal writing time threads spent in proportion to the elapsed time. This is summed for all of the threads writing on the host.

save-write-bytes

The number of bytes written when saving in-memory stands.

save-write-time

The time (as xs:dayTimeDuration) spent saving in-memory stands.

save-write-rate

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

save-write-load

The moving average of time threads spent writing to in-memory stands, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

merge-read-bytes

The number of bytes read during merges.

merge-read-time

The time (as xs:dayTimeDuration) to read data for merges.

merge-read-rate

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

merge-read-load

Disk read time threads spent during merge, in proportion to the elapsed time. This is summed for all of the contributing threads.

merge-write-bytes

The number of bytes written to disk for merges.

merge-write-time

The time (as xs:dayTimeDuration) to write data for merges.

merge-write-rate

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

merge-write-load

Disk writing time threads spent for merges, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

backup-read-bytes

The number of bytes read from disk for backups.

backup-read-time

Thee time (as xs:dayTimeDuration) to read data for backups.

backup-read-rate

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

backup-read-load

Disk read time threads spent for backup, in proportion to the elapsed time. This is summed for all of the contributing threads.

backup-write-bytes

The number of bytes written to disk for backups.

backup-write-time

The time (as xs:dayTimeDuration) to write data to backups.

backup-write-rate

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

backup-write-load

Disk writing time threads spent for backups, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

restore-read-bytes

The number of bytes read from disk for restores.

restore-read-time

The time (as xs:dayTimeDuration) to read data for restores.

restore-read-rate

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

restore-read-load

Disk read time threads spent for restores, in proportion to the elapsed time. This is summed for all of the contributing threads.

restore-write-bytes

The number of bytes written to disk for restores.

restore-write-time

The time (as xs:dayTimeDuration) to write data for restores.

restore-write-rate

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

restore-write-load

Disk write time threads spent for restores, in proportion to the elasped time. This is summed for all of the threads writing on the host.

large-read-bytes

The number of bytes read from large documents.

large-read-time

The time (as xs:dayTimeDuration) to read data from large documents.

large-read-rate

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

large-read-load

Disk read time threads spent on large documents, in proportion to the elapsed time.

large-write-bytes

The number of bytes written to disk for large documents.

large-write-time

The time (as xs:dayTimeDuration) to write data for large documents.

large-write-rate

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

large-write-load

Disk write time threads spent for large documents, in proportion to the elapsed time.

external-binary-read-bytes

The number of bytes read from external binary documents.

external-binary-read-time

Thee time (as xs:dayTimeDuration) to read data from external binary documents.

external-binary-read-rate

Disk read throughput of external binary documents, in megabytes per second.

external-binary-read-load

Disk read time threads spent on external binary documents, in proportion to the elapsed time.

webDAV-server-receive-bytes

The number of bytes received over the network of webDAV servers.

webDAV-server-receive-time

The time (as xs:dayTimeDuration) for network receivings of webDAV servers.

webDAV-server-receive-rate

The moving average throughput of webDAV servers receiving data, in megabytes per second.

webDAV-server-receive-load

Time threads spent receiving data for a webDAV servers, in proportion to the elapsed time.

webDAV-server-send-bytes

The number of bytes sent over the network of webDAV servers.

webDAV-server-send-time

The time (as xs:dayTimeDuration) for network sendings of webDAV servers.

webDAV-server-send-rate

The moving average throughput of webDAV servers sending data, in megabytes per second.

webDAV-server-send-load

Time threads spent sending data for a webDAV servers, in proportion to the elapsed time.

http-server-receive-bytes

The number of bytes received over the network of HTTP servers.

http-server-receive-time

The time (as xs:dayTimeDuration) of network receivings of HTTP servers.

http-server-receive-rate

The moving average throughput of HTTP servers receiving data, in megabytes per second.

http-server-receive-load

Time threads spent receiving data for HTTP servers, in proportion to the elapsed time.

http-server-send-bytes

The number of bytes sent over the network of HTTP servers.

http-server-send-time

The time (as xs:dayTimeDuration) for network sendings of HTTP servers.

http-server-send-rate

The moving average throughput of HTTP servers sending data, in megabytes per second.

http-server-send-load

Time threads spent sending data for HTTP servers, in proportion to the elapsed time.

xdbc-server-receive-bytes

The number of bytes received over the network of XDBC servers.

xdbc-server-receive-time

The time (as xs:dayTimeDuration) for network receivings of XDBC servers.

xdbc-server-receive-rate

The moving average throughput of XDBC servers receiving data, in megabytes per second.

xdbc-server-receive-load

Time threads spent receiving data for XDBC servers, in proportion to the elapsed time.

xdbc-server-send-bytes

The number of bytes sent over the network of XDBC servers.

xdbc-server-send-time

The time (as xs:dayTimeDuration) for network sendings of XDBC servers.

xdbc-server-send-rate

The moving average throughput of XDBC servers sending data, in megabytes per second.

xdbc-server-send-load

Time threads spent sending data from XDBC servers, in proportion to the elapsed time.

odbc-server-receive-bytes

The number of bytes received over the network of ODBC servers.

odbc-server-receive-time

The time (as xs:dayTimeDuration) for network receivings of ODBC server.

odbc-server-receive-rate

The moving average throughput of ODBC servers receiving data, in megabytes per second.

odbc-server-receive-load

Time threads spent receiving data for ODBC servers, in proportion to the elapsed time.

odbc-server-send-bytes

The number of bytes sent over the network of ODBC servers.

odbc-server-send-time

The time (as xs:dayTimeDuration) for network sendings of ODBC servers.

odbc-server-send-rate

The moving average throughput of ODBC servers sending data, in megabytes per second.

odbc-server-send-load

Time threads spent sending data for ODBC servers, in proportion to the elapsed time.

xdqp-client-receive-bytes

The number of bytes received by the xdqp client for host communications.

xdqp-client-receive-time

The time (as xs:dayTimeDuration) to receive xdqp client communication.

xdqp-client-receive-rate

The moving average throughput of the XDQP client receiving data, in megabytes per second.

xdqp-client-receive-load

Time threads spent receiving data for the xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-client-send-bytes

The number of bytes sent by the xdqp client for host communications.

xdqp-client-send-time

The time (as xs:dayTimeDuration) to send xdqp client communication.

xdqp-client-send-rate

The moving average throughput of the xdqp clients sending data, in megabytes per second.

xdqp-client-send-load

Time threads spent sending data for xdqp clients, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-receive-bytes

The number of bytes received by the xdqp server for host communications.

xdqp-server-receive-time

The time (as xs:dayTimeDuration) to receive xdqp server communication.

xdqp-server-receive-rate

The moving average throughput of the xdqp server receiving data, in megabytes per second.

xdqp-server-receive-load

Time threads spent receiving data for the xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-send-bytes

The number of bytes sent by the xdqp server for host communications.

xdqp-server-send-time

The time (as xs:dayTimeDuration) to send xdqp server communication.

xdqp-server-send-rate

The moving average throughput of the xdqp server sending data, in megabytes per second.

xdqp-server-send-load

Time threads spent sending data for the xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-request-time

Average response time of XDQP requests from other nodes.

xdqp-server-request-rate

Number of XDQP requests processed per second.

foreign-xdqp-client-receive-bytes

The number of bytes received by the xdqp client for host communications.

foreign-xdqp-client-receive-time

The time (as xs:dayTimeDuration) to receive xdqp client communication.

foreign-xdqp-client-receive-rate

The moving average throughput of the foreign xdqp client receiving data, in megabytes per second.

foreign-xdqp-client-receive-load

Time threads spent receiving data for the foreign xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-client-send-bytes

The number of bytes sent by the xdqp client for host communications.

foreign-xdqp-client-send-time

The time (as xs:dayTimeDuration) to send xdqp client communication.

foreign-xdqp-client-send-rate

The moving average throughput of the foreign xdqp client sending data, in megabytes per second.

foreign-xdqp-client-send-load

Time threads spent sending data for the foreign xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-server-receive-bytes

The number of bytes received by the xdqp server for host communications.

foreign-xdqp-server-receive-time

The time (as xs:dayTimeDuration) to receive xdqp server communication.

foreign-xdqp-server-receive-rate

The moving average throughput of the foreign xdqp server receiving data, in megabytes per second.

foreign-xdqp-server-receive-load

Time threads spent receiving data for the foreign xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-server-send-bytes

The number of bytes sent by the xdqp server for host communications.

foreign-xdqp-server-send-time

The time (as xs:dayTimeDuration) to send xdqp server communication.

foreign-xdqp-server-send-rate

The moving average throughput of the foreign xdqp server sending data, in megabytes per second.

foreign-xdqp-server-send-load

Time threads spent sending data for the foreign xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

read-lock-count

The total number of read locks, summed across all forests on the host.

read-lock-wait-time

The total time spent waiting for read locks, summed across all forests on the host.

read-lock-hold-time

The total time spent holding read locks, summed across all forests on the host.

read-lock-rate

The rate of read lock acquistions, summed across all forests on the host.

read-lock-wait-load

Time threads spent waiting to acquire read locks in proportion to the elasped time, summed across all forests on the host.

read-lock-hold-load

Time threads spent holding read locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-count

The total number of write lock acquistions, summed across all forests on the host.

write-lock-wait-time

The total time spent waiting for write locks, summed across all forests on the host.

write-lock-hold-time

The total time spent holding write locks, summed across all forests on the host.

write-lock-rate

The rate of write lock acquistions, summed across all forests on the host.

write-lock-wait-load

Time threads spent waiting to acquire write locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-hold-load

Time threads spent holding write locks in proportion to the elapsed time, summed across all forests on the host.

deadlock-count

The number of deadlocks, summed across all forests on the host.

deadlock-wait-time

The total time spent waiting for locks that eventually deadlocked, summed across all forests on the host.

deadlock-rate

The rate of deadlock occurrances, summed across all forests on the host.

deadlock-wait-load

Time threads spent waiting for locks that eventually result in deadlocks in proportion to the elasped time, summed across all forests on the host.

external-kms-request-rate

Number of requests per second to the external key management server.

external-kms-request-time

Average round-trip time for a request to an external key management server.

current-external-kms-host

Current external KMS host name.

ldap-request-rate

Number of requests per second to the LDAP server.

ldap-request-time

Average round-trip time for a request to the LDAP server.

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

==> Returns status information on the 'myhost' host.
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.

Comments

The commenting feature on this page is enabled by a third party. Comments posted to this page are publicly visible.