xdmp:host-status( $host-id as xs:unsignedLong* ) as element(host-status)*
Returns the status of a host.
Parameters | |
---|---|
host-id | A host ID. |
http://marklogic.com/xdmp/privileges/status
The information returned from
xdmp:host-status
is always
computed on the host specified in the $host-id
parameter,
even if the call is evaluated on an App Server running on a different host.
That is, when the API call is issued, MarkLogic Server communicates with
the specified host for the its status and returns the status from the
perspective of the specified host (not from the perspective of the host
in which the XQuery API is evaluated).
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.
The structure of the data returned is as follows:
host-id
error
host-name
group-id
zone
current-time
bind-port
connect-port
ssl-fips-enabled
foreign-bind-port
foreign-connect-port
background-io-limit
metering-enabled
meters-database
performance-metering-enabled
performance-metering-period
performance-metering-retain-raw
performance-metering-retain-hourly
performance-metering-retain-daily
last-startup
version
effective-version
software-version
os-version
converters-version
host-mode
host-mode-description
architecture
platform
license-key
licensee
license-key-expires
license-key-cpus
license-key-cores
license-key-size
license-key-options
This is a complex element with the following element children:
license-key-option
pre-release-expires
accepted-version
accepted-agreement
accepted-licensee
edition
environment
cpus
cores
core-threads
total-cpu-stat-user
total-cpu-stat-nice
total-cpu-stat-system
total-cpu-stat-idle
total-cpu-stat-iowait
total-cpu-stat-irq
total-cpu-stat-softirq
total-cpu-stat-steal
total-cpu-stat-guest
total-cpu-stat-guest-nice
cpu-stat-user
cpu-stat-nice
cpu-stat-system
cpu-stat-idle
cpu-stat-iowait
cpu-stat-irq
cpu-stat-softirq
cpu-stat-steal
cpu-stat-guest
cpu-stat-guest-nice
memory-process-size
memory-process-rss
memory-process-anon
memory-process-rss-hwm
memory-process-swap-rate
memory-process-swap-size
memory-process-huge-pages-size
memory-system-total
memory-system-free
memory-system-pagein-rate
memory-system-pageout-rate
memory-system-swapin-rate
memory-system-swapout-rate
memory-size
memory-file-size
memory-forest-size
memory-unclosed-size
memory-cache-size
memory-registry-size
memory-join-size
host-size
host-large-data-size
log-device-space
data-dir-space
config-file-timestamps
This is a complex element with the following element children:
groups-timestamp
hosts-timestamp
databases-timestamp
assignments-timestamp
tokenizer-timestamp
mimetypes-timestamp
http-servers
This is a complex element with the following element children:
http-server
This is a complex element with the following element children:
http-server-id
port
webDAV
xdbc-servers
This is a complex element with the following element children:
xdbc-server
This is a complex element with the following element children:
xdbc-server-id
port
odbc-servers
This is a complex element with the following element children:
odbc-server
This is a complex element with the following element children:
odbc-server-id
port
task-server
This is a complex element with the following element children:
task-server-id
assignments
This is a complex element with the following element children:
assignment
This is a complex element with the following element children:
forest-name
host-id
forest-id
hosts
This is a complex element with the following element children:
host
This is a complex element with the following element children:
host-id
host-name
connect-port
online
secure
last-online
last-offline
transactions
This is a complex element with the following element children:
transaction
This is a complex element with the following element children:
transaction-id
host-id
server-id
xa:xid
transaction-name
transaction-mode
transaction-timestamp
transaction-state
database-id
forest-id
canceled
start-time
time-limit
max-time-limit
join-size
join-size-strings
user
admin
backup-jobs
This is a complex element with the following element children:
backup-job
This is a complex element with the following element children:
job-id
path
start-time
forests
This is a complex element with the following element children:
forest
This is a complex element with the following element children:
forest-id
status
restore-jobs
This is a complex element with the following element children:
restore-job
This is a complex element with the following element children:
job-id
path
start-time
safe-restore-to-time
forests
This is a complex element with the following element children:
forest
This is a complex element with the following element children:
forest-id
status
native-plugins
This is a complex element with the following element children:
native-plugin
This is a complex element with the following element children:
path
version
capabilities
This is a complex element with the following element children:
aggregate
lexer
stemmer
query-read-bytes
query-read-time
query-read-rate
query-read-load
journal-write-bytes
journal-write-time
journal-write-rate
journal-write-load
save-write-bytes
save-write-time
save-write-rate
save-write-load
merge-read-bytes
merge-read-time
merge-read-rate
merge-read-load
merge-write-bytes
merge-write-time
merge-write-rate
merge-write-load
backup-read-bytes
backup-read-time
backup-read-rate
backup-read-load
backup-write-bytes
backup-write-time
backup-write-rate
backup-write-load
restore-read-bytes
restore-read-time
restore-read-rate
restore-read-load
restore-write-bytes
restore-write-time
restore-write-rate
restore-write-load
large-read-bytes
large-read-time
large-read-rate
large-read-load
large-write-bytes
large-write-time
large-write-rate
large-write-load
external-binary-read-bytes
external-binary-read-time
external-binary-read-rate
external-binary-read-load
webDAV-server-receive-bytes
webDAV-server-receive-time
webDAV-server-receive-rate
webDAV-server-receive-load
webDAV-server-send-bytes
webDAV-server-send-time
webDAV-server-send-rate
webDAV-server-send-load
http-server-receive-bytes
http-server-receive-time
http-server-receive-rate
http-server-receive-load
http-server-send-bytes
http-server-send-time
http-server-send-rate
http-server-send-load
xdbc-server-receive-bytes
xdbc-server-receive-time
xdbc-server-receive-rate
xdbc-server-receive-load
xdbc-server-send-bytes
xdbc-server-send-time
xdbc-server-send-rate
xdbc-server-send-load
odbc-server-receive-bytes
odbc-server-receive-time
odbc-server-receive-rate
odbc-server-receive-load
odbc-server-send-bytes
odbc-server-send-time
odbc-server-send-rate
odbc-server-send-load
xdqp-client-receive-bytes
xdqp-client-receive-time
xdqp-client-receive-rate
xdqp-client-receive-load
xdqp-client-send-bytes
xdqp-client-send-time
xdqp-client-send-rate
xdqp-client-send-load
xdqp-server-receive-bytes
xdqp-server-receive-time
xdqp-server-receive-rate
xdqp-server-receive-load
xdqp-server-send-bytes
xdqp-server-send-time
xdqp-server-send-rate
xdqp-server-send-load
xdqp-server-request-time
xdqp-server-request-rate
foreign-xdqp-client-receive-bytes
foreign-xdqp-client-receive-time
foreign-xdqp-client-receive-rate
foreign-xdqp-client-receive-load
foreign-xdqp-client-send-bytes
foreign-xdqp-client-send-time
foreign-xdqp-client-send-rate
foreign-xdqp-client-send-load
foreign-xdqp-server-receive-bytes
foreign-xdqp-server-receive-time
foreign-xdqp-server-receive-rate
foreign-xdqp-server-receive-load
foreign-xdqp-server-send-bytes
foreign-xdqp-server-send-time
foreign-xdqp-server-send-rate
foreign-xdqp-server-send-load
read-lock-count
read-lock-wait-time
read-lock-hold-time
read-lock-rate
read-lock-wait-load
read-lock-hold-load
write-lock-count
write-lock-wait-time
write-lock-hold-time
write-lock-rate
write-lock-wait-load
write-lock-hold-load
deadlock-count
deadlock-wait-time
deadlock-rate
deadlock-wait-load
external-kms-request-rate
external-kms-request-time
current-external-kms-host
keystore-status
keystore-status-detail
ldap-request-rate
ldap-request-time
xdmp:host-status(xdmp:host("engrlab-130-234.engrlab.marklogic.com")) => <host-status xmlns="http://marklogic.com/xdmp/status/host"> <host-id>4085572759432954311</host-id> <host-name>engrlab-130-234.engrlab.marklogic.com</host-name> <group-id>12157953645839352663</group-id> <zone/> <current-time>2017-11-17T09:49:05.846703-08:00</current-time> <bind-port>7999</bind-port> <connect-port>7999</connect-port> <ssl-fips-enabled>true</ssl-fips-enabled> <foreign-bind-port>7998</foreign-bind-port> <foreign-connect-port>7998</foreign-connect-port> <background-io-limit>0</background-io-limit> <metering-enabled>true</metering-enabled> <meters-database>1564550402179869619</meters-database> <performance-metering-enabled>true</performance-metering-enabled> <performance-metering-period>60</performance-metering-period> <performance-metering-retain-raw>7</performance-metering-retain-raw> <performance-metering-retain-hourly>30</performance-metering-retain-hourly> <performance-metering-retain-daily>90</performance-metering-retain-daily> <last-startup>2017-11-10T17:28:13.487467-08:00</last-startup> <version>9.0-20171107</version> <effective-version>9000400</effective-version> <software-version>9000400</software-version> <os-version>Linux 3.10.0-327.4.5.el7.x86_64 (Red Hat Enterprise Linux Server release 7.2 (Maipo))</os-version> <converters-version>9.0-4</converters-version> <host-mode>normal</host-mode> <host-mode-description/> <architecture>x86_64</architecture> <platform>linux</platform> <license-key/> <licensee/> <license-key-cpus>0</license-key-cpus> <license-key-cores>0</license-key-cores> <license-key-size>0</license-key-size> <license-key-options> <license-key-option>English</license-key-option> </license-key-options> <pre-release-expires>2018-02-05T01:43:29-08:00</pre-release-expires> <edition>Essential Enterprise</edition> <environment>developer</environment> <cpus>1</cpus> <cores>2</cores> <core-threads>2</core-threads> <total-cpu-stat-user>7.11657</total-cpu-stat-user> <total-cpu-stat-nice>0.0083626</total-cpu-stat-nice> <total-cpu-stat-system>0.367955</total-cpu-stat-system> <total-cpu-stat-idle>92.2813</total-cpu-stat-idle> <total-cpu-stat-iowait>0.209065</total-cpu-stat-iowait> <total-cpu-stat-irq>0</total-cpu-stat-irq> <total-cpu-stat-softirq>0.0083626</total-cpu-stat-softirq> <total-cpu-stat-steal>0.0083626</total-cpu-stat-steal> <total-cpu-stat-guest>0</total-cpu-stat-guest> <total-cpu-stat-guest-nice>0</total-cpu-stat-guest-nice> <memory-process-size>56193</memory-process-size> <memory-process-rss>36283</memory-process-rss> <memory-process-anon>33061</memory-process-anon> <memory-process-rss-hwm>36283</memory-process-rss-hwm> <memory-process-swap-size>0</memory-process-swap-size> <memory-process-huge-pages-size>0</memory-process-huge-pages-size> <memory-system-total>64333</memory-system-total> <memory-system-free>1823</memory-system-free> <memory-system-pagein-rate>0</memory-system-pagein-rate> <memory-system-pageout-rate>443.883</memory-system-pageout-rate> <memory-system-swapin-rate>0</memory-system-swapin-rate> <memory-system-swapout-rate>0</memory-system-swapout-rate> <memory-size>65536</memory-size> <memory-file-size>19749</memory-file-size> <memory-forest-size>23358</memory-forest-size> <memory-unclosed-size>0</memory-unclosed-size> <memory-cache-size>14830</memory-cache-size> <memory-registry-size>1</memory-registry-size> <memory-join-size>3190</memory-join-size> <host-size>144382</host-size> <host-large-data-size>0</host-large-data-size> <log-device-space>2201877</log-device-space> <data-dir-space>2201877</data-dir-space> <config-file-timestamps> <groups-timestamp>15100971420126390</groups-timestamp> <hosts-timestamp>15100960196086510</hosts-timestamp> <databases-timestamp>15100967861496740</databases-timestamp> <assignments-timestamp>15100967789608320</assignments-timestamp> <tokenizer-timestamp>0</tokenizer-timestamp> <mimetypes-timestamp>0</mimetypes-timestamp> </config-file-timestamps> <http-servers> <http-server> <http-server-id>12822528143234461636</http-server-id> <port>8009</port> <webDAV>false</webDAV> </http-server> <http-server> <http-server-id>1121943410553840519</http-server-id> <port>8002</port> <webDAV>false</webDAV> </http-server> <http-server> <http-server-id>5078523763460022581</http-server-id> <port>8008</port> <webDAV>false</webDAV> </http-server> <http-server> <http-server-id>11023473990212849141</http-server-id> <port>8001</port> <webDAV>false</webDAV> </http-server> <http-server> <http-server-id>1286398711478654471</http-server-id> <port>8003</port> <webDAV>false</webDAV> </http-server> <http-server> <http-server-id>10685799440368759035</http-server-id> <port>7997</port> <webDAV>false</webDAV> </http-server> <http-server> <http-server-id>18226655600726107841</http-server-id> <port>8000</port> <webDAV>false</webDAV> </http-server> </http-servers> <xdbc-servers/> <odbc-servers/> <task-server> <task-server-id>13196790179928447953</task-server-id> </task-server> <assignments> <assignment> <forest-name>Documents</forest-name> <forest-id>4239838981215574051</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>App-Services</forest-name> <forest-id>15345731627272000339</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Triggers</forest-name> <forest-id>17382220451822022492</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>OpsDirector-1</forest-name> <forest-id>13455432679337797727</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Fab</forest-name> <forest-id>7699747605762304543</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Modules</forest-name> <forest-id>7053508655703491157</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Security</forest-name> <forest-id>13229527886916569961</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Extensions</forest-name> <forest-id>12910059319482156324</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Last-Login</forest-name> <forest-id>10471487239899418477</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Meters</forest-name> <forest-id>11904294896473497471</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>Schemas</forest-name> <forest-id>6771691731658160035</forest-id> <host-id>4085572759432954311</host-id> </assignment> <assignment> <forest-name>OpsDirector-2</forest-name> <forest-id>6267645658628944817</forest-id> <host-id>4085572759432954311</host-id> </assignment> </assignments> <hosts> <host> <host-id>4085572759432954311</host-id> <host-name>engrlab-130-234.engrlab.marklogic.com</host-name> <connect-port>7999</connect-port> <online>true</online> <secure>false</secure> </host> </hosts> <transactions> <transaction> <transaction-id>12182946210591614111</transaction-id> <host-id>4085572759432954311</host-id> <server-id>18226655600726107841</server-id> <transaction-name/> <transaction-mode>query</transaction-mode> <transaction-timestamp>15109409436054590</transaction-timestamp> <transaction-state>active</transaction-state> <database-id>14941551758299859725</database-id> <canceled>false</canceled> <start-time>2017-11-17T09:49:05-08:00</start-time> <time-limit>600</time-limit> <max-time-limit>3600</max-time-limit> <join-size>0</join-size> <join-size-strings>0</join-size-strings> <user>7071164303237443533</user> <admin>true</admin> </transaction> <transaction> <transaction-id>4138644243492626532</transaction-id> <host-id>4085572759432954311</host-id> <server-id>18226655600726107841</server-id> <transaction-name/> <transaction-mode>query</transaction-mode> <transaction-timestamp>15109409436054590</transaction-timestamp> <transaction-state>active</transaction-state> <database-id>8741033773445629119</database-id> <canceled>false</canceled> <start-time>2017-11-17T09:49:05-08:00</start-time> <time-limit>600</time-limit> <max-time-limit>3600</max-time-limit> <join-size>0</join-size> <join-size-strings>0</join-size-strings> <user>7071164303237443533</user> <admin>true</admin> </transaction> </transactions> <backup-jobs/> <restore-jobs/> <native-plugins/> <query-read-bytes>59305472</query-read-bytes> <query-read-time>PT0.255131S</query-read-time> <query-read-rate>0.00266336</query-read-rate> <query-read-load>0</query-read-load> <journal-write-bytes>12580590240</journal-write-bytes> <journal-write-time>PT4M51.515096S</journal-write-time> <journal-write-rate>0.5734316</journal-write-rate> <journal-write-load>0</journal-write-load> <save-write-bytes>3729918931</save-write-bytes> <save-write-time>PT48.463044S</save-write-time> <save-write-rate>0</save-write-rate> <save-write-load>0</save-write-load> <merge-read-bytes>6308755584</merge-read-bytes> <merge-read-time>PT7.519165S</merge-read-time> <merge-read-rate>0</merge-read-rate> <merge-read-load>0</merge-read-load> <merge-write-bytes>10506325617</merge-write-bytes> <merge-write-time>PT1M5.113213S</merge-write-time> <merge-write-rate>0</merge-write-rate> <merge-write-load>0</merge-write-load> <backup-read-bytes>0</backup-read-bytes> <backup-read-time>PT0S</backup-read-time> <backup-read-rate>0</backup-read-rate> <backup-read-load>0</backup-read-load> <backup-write-bytes>0</backup-write-bytes> <backup-write-time>PT0S</backup-write-time> <backup-write-rate>0</backup-write-rate> <backup-write-load>0</backup-write-load> <restore-read-bytes>0</restore-read-bytes> <restore-read-time>PT0S</restore-read-time> <restore-read-rate>0</restore-read-rate> <restore-read-load>0</restore-read-load> <restore-write-bytes>0</restore-write-bytes> <restore-write-time>PT0S</restore-write-time> <restore-write-rate>0</restore-write-rate> <restore-write-load>0</restore-write-load> <large-read-bytes>0</large-read-bytes> <large-read-time>PT0S</large-read-time> <large-read-rate>0</large-read-rate> <large-read-load>0</large-read-load> <large-write-bytes>0</large-write-bytes> <large-write-time>PT0S</large-write-time> <large-write-rate>0</large-write-rate> <large-write-load>0</large-write-load> <external-binary-read-bytes>0</external-binary-read-bytes> <external-binary-read-time>PT0S</external-binary-read-time> <external-binary-read-rate>0</external-binary-read-rate> <external-binary-read-load>0</external-binary-read-load> <webDAV-server-receive-bytes>0</webDAV-server-receive-bytes> <webDAV-server-receive-time>PT0S</webDAV-server-receive-time> <webDAV-server-receive-rate>0</webDAV-server-receive-rate> <webDAV-server-receive-load>0</webDAV-server-receive-load> <webDAV-server-send-bytes>0</webDAV-server-send-bytes> <webDAV-server-send-time>PT0S</webDAV-server-send-time> <webDAV-server-send-rate>0</webDAV-server-send-rate> <webDAV-server-send-load>0</webDAV-server-send-load> <http-server-receive-bytes>161432668</http-server-receive-bytes> <http-server-receive-time>PT20.616955S</http-server-receive-time> <http-server-receive-rate>0.04341966</http-server-receive-rate> <http-server-receive-load>0</http-server-receive-load> <http-server-send-bytes>0</http-server-send-bytes> <http-server-send-time>PT0S</http-server-send-time> <http-server-send-rate>0</http-server-send-rate> <http-server-send-load>0</http-server-send-load> <xdbc-server-receive-bytes>0</xdbc-server-receive-bytes> <xdbc-server-receive-time>PT0S</xdbc-server-receive-time> <xdbc-server-receive-rate>0</xdbc-server-receive-rate> <xdbc-server-receive-load>0</xdbc-server-receive-load> <xdbc-server-send-bytes>0</xdbc-server-send-bytes> <xdbc-server-send-time>PT0S</xdbc-server-send-time> <xdbc-server-send-rate>0</xdbc-server-send-rate> <xdbc-server-send-load>0</xdbc-server-send-load> <odbc-server-receive-bytes>0</odbc-server-receive-bytes> <odbc-server-receive-time>PT0S</odbc-server-receive-time> <odbc-server-receive-rate>0</odbc-server-receive-rate> <odbc-server-receive-load>0</odbc-server-receive-load> <odbc-server-send-bytes>0</odbc-server-send-bytes> <odbc-server-send-time>PT0S</odbc-server-send-time> <odbc-server-send-rate>0</odbc-server-send-rate> <odbc-server-send-load>0</odbc-server-send-load> <xdqp-client-receive-bytes>0</xdqp-client-receive-bytes> <xdqp-client-receive-time>PT0S</xdqp-client-receive-time> <xdqp-client-receive-rate>0</xdqp-client-receive-rate> <xdqp-client-receive-load>0</xdqp-client-receive-load> <xdqp-client-send-bytes>0</xdqp-client-send-bytes> <xdqp-client-send-time>PT0S</xdqp-client-send-time> <xdqp-client-send-rate>0</xdqp-client-send-rate> <xdqp-client-send-load>0</xdqp-client-send-load> <xdqp-server-receive-bytes>0</xdqp-server-receive-bytes> <xdqp-server-receive-time>PT0S</xdqp-server-receive-time> <xdqp-server-receive-rate>0</xdqp-server-receive-rate> <xdqp-server-receive-load>0</xdqp-server-receive-load> <xdqp-server-send-bytes>0</xdqp-server-send-bytes> <xdqp-server-send-time>PT0S</xdqp-server-send-time> <xdqp-server-send-rate>0</xdqp-server-send-rate> <xdqp-server-send-load>0</xdqp-server-send-load> <foreign-xdqp-client-receive-bytes>0</foreign-xdqp-client-receive-bytes> <foreign-xdqp-client-receive-time>PT0S</foreign-xdqp-client-receive-time> <foreign-xdqp-client-receive-rate>0</foreign-xdqp-client-receive-rate> <foreign-xdqp-client-receive-load>0</foreign-xdqp-client-receive-load> <foreign-xdqp-client-send-bytes>0</foreign-xdqp-client-send-bytes> <foreign-xdqp-client-send-time>PT0S</foreign-xdqp-client-send-time> <foreign-xdqp-client-send-rate>0</foreign-xdqp-client-send-rate> <foreign-xdqp-client-send-load>0</foreign-xdqp-client-send-load> <foreign-xdqp-server-receive-bytes>0</foreign-xdqp-server-receive-bytes> <foreign-xdqp-server-receive-time>PT0S</foreign-xdqp-server-receive-time> <foreign-xdqp-server-receive-rate>0</foreign-xdqp-server-receive-rate> <foreign-xdqp-server-receive-load>0</foreign-xdqp-server-receive-load> <foreign-xdqp-server-send-bytes>0</foreign-xdqp-server-send-bytes> <foreign-xdqp-server-send-time>PT0S</foreign-xdqp-server-send-time> <foreign-xdqp-server-send-rate>0</foreign-xdqp-server-send-rate> <foreign-xdqp-server-send-load>0</foreign-xdqp-server-send-load> <read-lock-count>2231497</read-lock-count> <read-lock-wait-time>PT4.969228S</read-lock-wait-time> <read-lock-hold-time>P10DT15H2M4.3654596S</read-lock-hold-time> <read-lock-rate>12.21794</read-lock-rate> <read-lock-wait-load>0</read-lock-wait-load> <read-lock-hold-load>5.186479</read-lock-hold-load> <write-lock-count>557532</write-lock-count> <write-lock-wait-time>PT0.903263S</write-lock-wait-time> <write-lock-hold-time>P2DT9H22M48.3008447S</write-lock-hold-time> <write-lock-rate>3.242629</write-lock-rate> <write-lock-wait-load>0</write-lock-wait-load> <write-lock-hold-load>1.335788</write-lock-hold-load> <deadlock-count>0</deadlock-count> <deadlock-wait-time>PT0S</deadlock-wait-time> <deadlock-rate>0</deadlock-rate> <deadlock-wait-load>0</deadlock-wait-load> <external-kms-request-rate>0</external-kms-request-rate> <external-kms-request-time>0</external-kms-request-time> <current-external-kms-host>safenet150v-3.marklogic.com</current-external-kms-host> </host-status>
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.