[DRILL-6408] Document Drill API /cluster.json states

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 1.13.0
• Component/s: Server, Client - HTTP, Documentation, Execution - Monitoring, Tools, Build & Test

Environment

MapR 6.0 / Apache Drill in Docker

• Assignee: Unassigned
• Reporter: Hari Sekhon
• Created: 11/May/18 15:10
• Updated: 11/May/18 15:15

Description

Request to document the possible states returned by Drill API's newer /cluster.json endpoint:

https://drill.apache.org/docs/rest-api-introduction/#get-/cluster.json

Real world output shows an interesting 'state' field which is currently undocumented in the link above, but you can see here:

{
  "drillbits" : [ {
    "address" : "1939919665a9",
    "userPort" : "31010",
    "controlPort" : "31011",
    "dataPort" : "31012",
    "version" : "1.13.0",
    "current" : true,
    "versionMatch" : true,
    "state" : "ONLINE"
  } ],
  "currentVersion" : "1.13.0",
  "mismatchedVersions" : [ ],
  "userEncryptionEnabled" : false,
  "bitEncryptionEnabled" : false,
  "authEnabled" : false
}

Issue Links

• relates to: DRILL-6407 Document API /status responses, currently only "Running" is shown in docs