Loading TOC...

MarkLogic 12 Product Documentation
GET /manage/v2?view=healthcheck

Summary

This resource address returns a health check status for the local cluster.

URL Parameters
format The format of the returned data. Can be either xml, json, or html (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

Example


      curl --anyauth --user username:password -i -H "Accept: application/xml" \
  http://localhost:8002/manage/v2?view=healthcheck
    
      ==>  MarkLogic responds with output similar to the following. (The output 
      has been truncated in this example.)

      HTTP/1.1 200 OK
      Content-type: application/xml; charset=UTF-8
      Cache-Control: no-cache
      Expires: -1
      Server: MarkLogic
      Content-Length: 3787
      Connection: Keep-Alive
      Keep-Alive: timeout=5

      <healthcheck-status xmlns="http://marklogic.com/xdmp/status/healthcheck">
        <cluster-id>2906597636532997928</cluster-id>
        <host-id>3240964645260604008</host-id>
        <server-initializing>false</server-initializing>
        <server-restarting>false</server-restarting>
        <server-shutdown>false</server-shutdown>
        <quorum-exists>true</quorum-exists>
        <server-health-statuses>
          <server-health-status>
            <server-id>1165030470826938931</server-id>
            <healthy>true</healthy>
          </server-health-status>
          <server-health-status>
            <server-id>14009994255214134022</server-id>
            <healthy>true</healthy>
          </server-health-status>
          <server-health-status>
            <server-id>6427134568955651886</server-id>
            <healthy>true</healthy>
          </server-health-status>
          <server-health-status>
            <server-id>3070680562264010318</server-id>
            <healthy>true</healthy>
          </server-health-status>
          <server-health-status>
            <server-id>15519558185011729043</server-id>
            <healthy>true</healthy>
          </server-health-status>
          <server-health-status>
            <server-id>17916760850379909072</server-id>
            <healthy>true</healthy>
          </server-health-status>
          <server-health-status>
            <server-id>7172396041982817671</server-id>
            <healthy>true</healthy>
          </server-health-status>
        </server-health-statuses>
        <background-health-statuses>
          <background-health-status>
            <background-name>XDQP Server</background-name>
            <healthy>true</healthy>
          </background-health-status>
          <background-health-status>
            <background-name>database</background-name>
            <healthy>true</healthy>
          </background-health-status>
          <background-health-status>
            <background-name>unknown</background-name>
            <healthy>true</healthy>
          </background-health-status>
          <background-health-status>
            <background-name>server background delay check</background-name>
            <healthy>true</healthy>
          </background-health-status>
        </background-health-statuses>
        <database-health-statuses>
          <database-health-status>
            <database-id>16184979147749190886</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>4889075525780374620</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>15224559436090599921</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>12254537542030041531</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>11218328292406182375</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>6363459528339850807</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>13552680928928202896</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>3803397392867501939</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>7794579437791726340</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>6826631521408507642</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>11886429331292725934</database-id>
            <healthy>true</healthy>
          </database-health-status>
          <database-health-status>
            <database-id>13194416295755380263</database-id>
            <healthy>true</healthy>
          </database-health-status>
        </database-health-statuses>
      </healthcheck-status>

Example


      curl --anyauth --user username:password -i -H "Accept: application/json" \
      http://localhost:8002/manage/v2?view=healthcheck
        
      ==>  MarkLogic responds with output similar to the following. (The output 
      has been truncated in this example.)

      HTTP/1.1 200 OK
      Content-type: application/json; charset=UTF-8
      Cache-Control: no-cache
      Expires: -1
      Server: MarkLogic
      Content-Length: 1498
      Connection: Keep-Alive
      Keep-Alive: timeout=5

      {
        "clusterId":"2906597636532997928",
        "hostId":"3240964645260604008",
        "serverInitializing":false,
        "serverRestarting":false,
        "serverShutdown":false,
        "quorumExists":true,
        "serverHealthStatus":[
           {
              "serverId":"1165030470826938931",
              "healthy":true
           },
           {
              "serverId":"14009994255214134022",
              "healthy":true
           },
           {
              "serverId":"6427134568955651886",
              "healthy":true
           },
           {
              "serverId":"3070680562264010318",
              "healthy":true
           },
           {
              "serverId":"15519558185011729043",
              "healthy":true
           },
           {
              "serverId":"17916760850379909072",
              "healthy":true
           },
           {
              "serverId":"7172396041982817671",
              "healthy":true
           }
        ],
        "backgroundHealthStatus":[
           {
              "backgroundName":"XDQP Server",
              "healthy":true
           },
           {
              "backgroundName":"database",
              "healthy":true
           },
           {
              "backgroundName":"unknown",
              "healthy":true
           },
           {
              "backgroundName":"server background delay check",
              "healthy":true
           }
        ],
        "databaseHealthStatus":[
           {
              "databaseId":"16184979147749190886",
              "healthy":"true"
           },
           {
              "databaseId":"4889075525780374620",
              "healthy":"true"
           },
           {
              "databaseId":"15224559436090599921",
              "healthy":"true"
           },
           {
              "databaseId":"12254537542030041531",
              "healthy":"true"
           },
           {
              "databaseId":"11218328292406182375",
              "healthy":"true"
           },
           {
              "databaseId":"6363459528339850807",
              "healthy":"true"
           },
           {
              "databaseId":"13552680928928202896",
              "healthy":"true"
           },
           {
              "databaseId":"3803397392867501939",
              "healthy":"true"
           },
           {
              "databaseId":"7794579437791726340",
              "healthy":"true"
           },
           {
              "databaseId":"6826631521408507642",
              "healthy":"true"
           },
           {
              "databaseId":"11886429331292725934",
              "healthy":"true"
           },
           {
              "databaseId":"13194416295755380263",
              "healthy":"true"
           }
        ]
      }

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