
xdmp.hostStatus( host-id as (Number|String)[] ) as Sequence
Returns the status of a host as a JSON node.
| Parameters | |
|---|---|
| host-id | A host ID. |
http://marklogic.com/xdmp/privileges/status
The information returned from
xdmp.hostStatus 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).
The individual statuses are of type ObjectNode.
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:
hostIderrorhostNamegroupIdzoneisDynamiccurrentTimebindPortconnectPortsslFipsEnabledforeignBindPortforeignConnectPortbackgroundIoLimitmeteringEnabledmetersDatabaseperformanceMeteringEnabledperformanceMeteringPeriodperformanceMeteringRetainRawperformanceMeteringRetainHourlyperformanceMeteringRetainDailylastStartupversioneffectiveVersionsoftwareVersionosVersionconvertersVersionhostModehostModeDescriptionarchitectureplatformlicenseKeylicenseelicenseKeyExpireslicenseKeyCpuslicenseKeyCoreslicenseKeySizelicenseKeyOptionsThis is an object with the following properties:
licenseKeyOptionpreReleaseExpiresacceptedVersionacceptedAgreementacceptedLicenseeeditionenvironmentcpuscorescoreThreadstotalCpuStatUsertotalCpuStatNicetotalCpuStatSystemtotalCpuStatIdletotalCpuStatIowaittotalCpuStatIrqtotalCpuStatSoftirqtotalCpuStatStealtotalCpuStatGuesttotalCpuStatGuestNicecpuStatUsercpuStatNicecpuStatSystemcpuStatIdlecpuStatIowaitcpuStatIrqcpuStatSoftirqcpuStatStealcpuStatGuestcpuStatGuestNicememoryProcessSizememoryProcessRssmemoryProcessAnonmemoryProcessRssHwmmemoryProcessSwapRatememoryProcessSwapSizememoryProcessHugePagesSizememorySystemTotalmemorySystemFreememorySystemPageinRatememorySystemPageoutRatememorySystemSwapinRatememorySystemSwapoutRatememorySizememoryFileSizememoryForestSizememoryUnclosedSizememoryCacheSizememoryRegistrySizememoryJoinSizehostSizehostLargeDataSizelogDeviceSpacedataDirSpaceconfigFileTimestampsThis is an object with the following properties:
groupsTimestamphostsTimestampdatabasesTimestampassignmentsTimestamptokenizerTimestampmimetypesTimestamphttpServersThis is an object with the following properties:
httpServerThis is an object with the following properties:
httpServerIdportwebDAVxdbcServersThis is an object with the following properties:
xdbcServerThis is an object with the following properties:
xdbcServerIdportodbcServersThis is an object with the following properties:
odbcServerThis is an object with the following properties:
odbcServerIdporttaskServerThis is an object with the following properties:
taskServerIdassignmentsThis is an object with the following properties:
assignmentThis is an object with the following properties:
forestNamehostIdforestIdhostsThis is an object with the following properties:
hostThis is an object with the following properties:
hostIdhostNameconnectPortonlinesecurelastOnlinelastOfflinetransactionsThis is an object with the following properties:
transactionThis is an object with the following properties:
transactionIdhostIdserverIdxa.xidtransactionNametransactionModetransactionTimestamptransactionStatedatabaseIdforestIdcanceledstartTimetimeLimitmaxTimeLimitjoinSizejoinSizeStringsuseradminbackupJobsThis is an object with the following properties:
backupJobThis is an object with the following properties:
jobIdpathstartTimeforestsThis is an object with the following properties:
forestThis is an object with the following properties:
forestIdstatusrestoreJobsThis is an object with the following properties:
restoreJobThis is an object with the following properties:
jobIdpathstartTimesafeRestoreToTimeforestsThis is an object with the following properties:
forestThis is an object with the following properties:
forestIdstatusnativePluginsThis is an object with the following properties:
nativePluginThis is an object with the following properties:
pathversioncapabilitiesThis is an object with the following properties:
aggregatelexerstemmerqueryReadBytesqueryReadTimequeryReadRatequeryReadLoadjournalWriteBytesjournalWriteTimejournalWriteRatejournalWriteLoadsaveWriteBytessaveWriteTimesaveWriteRatesaveWriteLoadmergeReadBytesmergeReadTimemergeReadRatemergeReadLoadmergeWriteBytesmergeWriteTimemergeWriteRatemergeWriteLoadbackupReadBytesbackupReadTimebackupReadRatebackupReadLoadbackupWriteBytesbackupWriteTimebackupWriteRatebackupWriteLoadrestoreReadBytesrestoreReadTimerestoreReadRaterestoreReadLoadrestoreWriteBytesrestoreWriteTimerestoreWriteRaterestoreWriteLoadlargeReadByteslargeReadTimelargeReadRatelargeReadLoadlargeWriteByteslargeWriteTimelargeWriteRatelargeWriteLoadexternalBinaryReadBytesexternalBinaryReadTimeexternalBinaryReadRateexternalBinaryReadLoadwebDAVServerReceiveByteswebDAVServerReceiveTimewebDAVServerReceiveRatewebDAVServerReceiveLoadwebDAVServerSendByteswebDAVServerSendTimewebDAVServerSendRatewebDAVServerSendLoadhttpServerReceiveByteshttpServerReceiveTimehttpServerReceiveRatehttpServerReceiveLoadhttpServerSendByteshttpServerSendTimehttpServerSendRatehttpServerSendLoadxdbcServerReceiveBytesxdbcServerReceiveTimexdbcServerReceiveRatexdbcServerReceiveLoadxdbcServerSendBytesxdbcServerSendTimexdbcServerSendRatexdbcServerSendLoadodbcServerReceiveBytesodbcServerReceiveTimeodbcServerReceiveRateodbcServerReceiveLoadodbcServerSendBytesodbcServerSendTimeodbcServerSendRateodbcServerSendLoadxdqpClientReceiveBytesxdqpClientReceiveTimexdqpClientReceiveRatexdqpClientReceiveLoadxdqpClientSendBytesxdqpClientSendTimexdqpClientSendRatexdqpClientSendLoadxdqpServerReceiveBytesxdqpServerReceiveTimexdqpServerReceiveRatexdqpServerReceiveLoadxdqpServerSendBytesxdqpServerSendTimexdqpServerSendRatexdqpServerSendLoadxdqpServerRequestTimexdqpServerRequestRateforeignXdqpClientReceiveBytesforeignXdqpClientReceiveTimeforeignXdqpClientReceiveRateforeignXdqpClientReceiveLoadforeignXdqpClientSendBytesforeignXdqpClientSendTimeforeignXdqpClientSendRateforeignXdqpClientSendLoadforeignXdqpServerReceiveBytesforeignXdqpServerReceiveTimeforeignXdqpServerReceiveRateforeignXdqpServerReceiveLoadforeignXdqpServerSendBytesforeignXdqpServerSendTimeforeignXdqpServerSendRateforeignXdqpServerSendLoadreadLockCountreadLockWaitTimereadLockHoldTimereadLockRatereadLockWaitLoadreadLockHoldLoadwriteLockCountwriteLockWaitTimewriteLockHoldTimewriteLockRatewriteLockWaitLoadwriteLockHoldLoaddeadlockCountdeadlockWaitTimedeadlockRatedeadlockWaitLoadexternalKmsRequestRateexternalKmsRequestTimecurrentExternalKmsHostkeystoreStatuskeystoreStatusDetailldapRequestRateldapRequestTime
xdmp.hostStatus(xdmp.host("engrlab-130-234.engrlab.marklogic.com"));
=>
{
"hostId" : "4085572759432954311",
"hostName" : "engrlab-130-234.engrlab.marklogic.com",
"groupId" : "12157953645839352663",
"zone" : "",
"currentTime" : "2017-11-17T11:50:49.572635-08:00",
"bindPort" : 7999,
"connectPort" : 7999,
"sslFipsEnabled" : true,
"foreignBindPort" : 7998,
"foreignConnectPort" : 7998,
"backgroundIoLimit" : 0,
"meteringEnabled" : true,
"metersDatabase" : "1564550402179869619",
"performanceMeteringEnabled" : true,
"performanceMeteringPeriod" : 60,
"performanceMeteringRetainRaw" : 7,
"performanceMeteringRetainHourly" : 30,
"performanceMeteringRetainDaily" : 90,
"lastStartup" : "2017-11-10T17:28:13.487467-08:00",
"version" : "9.0-20171107",
"effectiveVersion" : 9000400,
"softwareVersion" : 9000400,
"convertersVersion" : "9.0-4",
"mode" : "normal",
"modeDescription" : "",
"architecture" : "x86_64",
"platform" : "linux",
"licenseKey" : "",
"licensee" : "",
"licenseKeyCpus" : 0,
"licenseKeyCores" : 0,
"licenseKeySize" : 0,
"licenseKeyOptions" : ["English"],
"preReleaseExpires" : "2018-02-05T01:43:29-08:00",
"edition" : "Essential Enterprise",
"environment" : "developer",
"cpus" : 1,
"cores" : 2,
"coreThreads" : 2,
"totalCpuStatUser": 19.767053604126,
"totalCpuStatNice": 0.00208858377300203,
"totalCpuStatSystem": 1.08049404621124,
"totalCpuStatIdle": 78.9707489013672,
"totalCpuStatIowait": 0,
"totalCpuStatIrq": 0.116960689425468,
"totalCpuStatSoftirq": 0.0626575127243996,
"totalCpuStatSteal": 0,
"totalCpuStatGuest": 0,
"totalCpuStatGuestNice": 0,
"memoryProcessSize": 50723,
"memoryProcessRss": 30049,
"memoryProcessAnon": 26819,
"memoryProcessRssHwm": 30049,
"memoryProcessSwapSize": 0,
"memoryProcessHugePagesSize": 0,
"memorySystemTotal": 64333,
"memorySystemFree": 16071,
"memorySystemPageinRate": 0.0668033957481384,
"memorySystemPageoutRate": 9.15206527709961,
"memorySystemSwapinRate": 0,
"memorySystemSwapoutRate": 0,
"memorySize": 65536,
"memoryFileSize": 19749,
"memoryForestSize": 23358,
"memoryUnclosedSize": 1,
"memoryCacheSize": 14431,
"memoryRegistrySize": 1,
"memoryJoinSize": 17552,
"hostSize": 144382,
"hostLargeDataSize": 0,
"logDeviceSpace": 2201876,
"dataDirSpace": 2201876,
"configFileTimestamps" : {
"groupsTimestamp" : "15100971420126390",
"hostsTimestamp" : "15100960196086510",
"databasesTimestamp" : "15100967861496740",
"assignmentsTimestamp" : "15100967789608320",
"tokenizerTimestamp" : 0,
"mimetypesTimestamp" : 0
},
"httpServers" : [{
"httpServerId" : "12822528143234461636",
"port" : 8009,
"webDAV" : false
}, {
"httpServerId" : "1121943410553840519",
"port" : 8002,
"webDAV" : false
}, {
"httpServerId" : "5078523763460022581",
"port" : 8008,
"webDAV" : false
}, {
"httpServerId" : "11023473990212849141",
"port" : 8001,
"webDAV" : false
}, {
"httpServerId" : "1286398711478654471",
"port" : 8003,
"webDAV" : false
}, {
"httpServerId" : "10685799440368759035",
"port" : 7997,
"webDAV" : false
}, {
"httpServerId" : "18226655600726107841",
"port" : 8000,
"webDAV" : false
}
],
"xdbcServers" : [],
"odbcServers" : [],
"taskServer" : {
"taskServerId" : "13196790179928447953"
},
"assignments" : [{
"forestName" : "Documents",
"forestId" : "4239838981215574051",
"hostId" : "4085572759432954311"
}, {
"forestName" : "App-Services",
"forestId" : "15345731627272000339",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Triggers",
"forestId" : "17382220451822022492",
"hostId" : "4085572759432954311"
}, {
"forestName" : "OpsDirector-1",
"forestId" : "13455432679337797727",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Fab",
"forestId" : "7699747605762304543",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Modules",
"forestId" : "7053508655703491157",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Security",
"forestId" : "13229527886916569961",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Extensions",
"forestId" : "12910059319482156324",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Last-Login",
"forestId" : "10471487239899418477",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Meters",
"forestId" : "11904294896473497471",
"hostId" : "4085572759432954311"
}, {
"forestName" : "Schemas",
"forestId" : "6771691731658160035",
"hostId" : "4085572759432954311"
}, {
"forestName" : "OpsDirector-2",
"forestId" : "6267645658628944817",
"hostId" : "4085572759432954311"
}
],
"hosts" : [{
"hostId" : "4085572759432954311",
"hostName" : "engrlab-130-234.engrlab.marklogic.com",
"connectPort" : 7999,
"online" : true,
"secure" : false
}
],
"transactions" : [{
"transactionId" : "16396290563812779980",
"hostId" : "4085572759432954311",
"serverId" : "18226655600726107841",
"transactionName" : "",
"transactionMode" : "query",
"transactionTimestamp" : "15109482457852770",
"transactionState" : "active",
"databaseId" : "8741033773445629119",
"canceled" : false,
"startTime" : "2017-11-17T11:50:49-08:00",
"timeLimit" : 600,
"maxTimeLimit" : 3600,
"joinSize" : 0,
"joinSizeStrings" : 0,
"user" : "7071164303237443533",
"admin" : true
}, {
"transactionId" : "9253497387517357741",
"hostId" : "4085572759432954311",
"serverId" : "18226655600726107841",
"transactionName" : "",
"transactionMode" : "update",
"transactionTimestamp" : 0,
"transactionState" : "active",
"databaseId" : "14941551758299859725",
"canceled" : false,
"startTime" : "2017-11-17T11:50:49-08:00",
"timeLimit" : 600,
"maxTimeLimit" : 3600,
"joinSize" : 0,
"joinSizeStrings" : 0,
"user" : "7071164303237443533",
"admin" : true
}
],
"backupJobs" : [],
"restoreJobs" : [],
"nativePlugins" : [],
"queryReadBytes" : 59672576,
"queryReadTime" : "PT0.255806S",
"queryReadRate" : 0.00544838001951575,
"queryReadLoad" : 0,
"journalWriteBytes" : 12742375588,
"journalWriteTime" : "PT4M55.185753S",
"journalWriteRate" : 0.0308803580701351,
"journalWriteLoad" : 0,
"saveWriteBytes" : 3752009824,
"saveWriteTime" : "PT48.880503S",
"saveWriteRate" : 0,
"saveWriteLoad" : 0,
"mergeReadBytes" : 6319897024,
"mergeReadTime" : "PT7.530605S",
"mergeReadRate" : 0,
"mergeReadLoad" : 0,
"mergeWriteBytes" : 10551679171,
"mergeWriteTime" : "PT1M5.724851S",
"mergeWriteRate" : 0,
"mergeWriteLoad" : 0,
"backupReadBytes" : 0,
"backupReadTime" : "PT0S",
"backupReadRate" : 0,
"backupReadLoad" : 0,
"backupWriteBytes" : 0,
"backupWriteTime" : "PT0S",
"backupWriteRate" : 0,
"backupWriteLoad" : 0,
"restoreReadBytes" : 0,
"restoreReadTime" : "PT0S",
"restoreReadRate" : 0,
"restoreReadLoad" : 0,
"restoreWriteBytes" : 0,
"restoreWriteTime" : "PT0S",
"restoreWriteRate" : 0,
"restoreWriteLoad" : 0,
"largeReadBytes" : 0,
"largeReadTime" : "PT0S",
"largeReadRate" : 0,
"largeReadLoad" : 0,
"largeWriteBytes" : 0,
"largeWriteTime" : "PT0S",
"largeWriteRate" : 0,
"largeWriteLoad" : 0,
"externalBinaryReadBytes" : 0,
"externalBinaryReadTime" : "PT0S",
"externalBinaryReadRate" : 0,
"externalBinaryReadLoad" : 0,
"webDAVServerReceiveBytes" : 0,
"webDAVServerReceiveTime" : "PT0S",
"webDAVServerReceiveRate" : 0,
"webDAVServerReceiveLoad" : 0,
"webDAVServerSendBytes" : 0,
"webDAVServerSendTime" : "PT0S",
"webDAVServerSendRate" : 0,
"webDAVServerSendLoad" : 0,
"httpServerReceiveBytes" : 163478036,
"httpServerReceiveTime" : "PT20.908924S",
"httpServerReceiveRate" : 0.00312820496037602,
"httpServerReceiveLoad" : 0,
"httpServerSendBytes" : 0,
"httpServerSendTime" : "PT0S",
"httpServerSendRate" : 0,
"httpServerSendLoad" : 0,
"xdbcServerReceiveBytes" : 0,
"xdbcServerReceiveTime" : "PT0S",
"xdbcServerReceiveRate" : 0,
"xdbcServerReceiveLoad" : 0,
"xdbcServerSendBytes" : 0,
"xdbcServerSendTime" : "PT0S",
"xdbcServerSendRate" : 0,
"xdbcServerSendLoad" : 0,
"odbcServerReceiveBytes" : 0,
"odbcServerReceiveTime" : "PT0S",
"odbcServerReceiveRate" : 0,
"odbcServerReceiveLoad" : 0,
"odbcServerSendBytes" : 0,
"odbcServerSendTime" : "PT0S",
"odbcServerSendRate" : 0,
"odbcServerSendLoad" : 0,
"xdqpClientReceiveBytes" : 0,
"xdqpClientReceiveTime" : "PT0S",
"xdqpClientReceiveRate" : 0,
"xdqpClientReceiveLoad" : 0,
"xdqpClientSendBytes" : 0,
"xdqpClientSendTime" : "PT0S",
"xdqpClientSendRate" : 0,
"xdqpClientSendLoad" : 0,
"xdqpServerReceiveBytes" : 0,
"xdqpServerReceiveTime" : "PT0S",
"xdqpServerReceiveRate" : 0,
"xdqpServerReceiveLoad" : 0,
"xdqpServerSendBytes" : 0,
"xdqpServerSendTime" : "PT0S",
"xdqpServerSendRate" : 0,
"xdqpServerSendLoad" : 0,
"foreignXdqpClientReceiveBytes" : 0,
"foreignXdqpClientReceiveTime" : "PT0S",
"foreignXdqpClientReceiveRate" : 0,
"foreignXdqpClientReceiveLoad" : 0,
"foreignXdqpClientSendBytes" : 0,
"foreignXdqpClientSendTime" : "PT0S",
"foreignXdqpClientSendRate" : 0,
"foreignXdqpClientSendLoad" : 0,
"foreignXdqpServerReceiveBytes" : 0,
"foreignXdqpServerReceiveTime" : "PT0S",
"foreignXdqpServerReceiveRate" : 0,
"foreignXdqpServerReceiveLoad" : 0,
"foreignXdqpServerSendBytes" : 0,
"foreignXdqpServerSendTime" : "PT0S",
"foreignXdqpServerSendRate" : 0,
"foreignXdqpServerSendLoad" : 0,
"readLockCount" : 2259711,
"readLockWaitTime" : "PT5.039021S",
"readLockHoldTime" : "P10DT18H16M20.7365357S",
"readLockRate" : 1.46194648742676,
"readLockWaitLoad" : 0,
"readLockHoldLoad" : 0.329852998256683,
"writeLockCount" : 564978,
"writeLockWaitTime" : "PT0.912597S",
"writeLockHoldTime" : "P2DT10H7M31.9426108S",
"writeLockRate" : 0.279558062553406,
"writeLockWaitLoad" : 0,
"writeLockHoldLoad" : 0.0683934390544891,
"deadlockCount" : 0,
"deadlockWaitTime" : "PT0S",
"deadlockRate" : 0,
"deadlockWaitLoad" : 0
}
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.