cluster

Cluster operations, from initial setup to status.

GET /cluster/status/nagios/{check}

Parameters

check
string
path
-

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/status/nagios/{check}
                

Response 200

Example response

"string"
                  

GET /cluster/releases

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/releases
                

Response 200

mon
array
optional
-
mgr
array
optional
-
osd
array
optional
-
mds
array
optional
-
overall
array
optional
-
other
object
optional
-

Example response

{
  "mon": [
    {
      "release": "LUMINOUS",
      "count": 0
    }
  ],
  "mgr": [
    {
      "release": "LUMINOUS",
      "count": 0
    }
  ],
  "osd": [
    {
      "release": "LUMINOUS",
      "count": 0
    }
  ],
  "mds": [
    {
      "release": "LUMINOUS",
      "count": 0
    }
  ],
  "overall": [
    {
      "release": "LUMINOUS",
      "count": 0
    }
  ],
  "other": {}
}
                  

GET /cluster/create/mons

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/create/mons
                

Response 200

id
integer
optional
-
hostname
string
optional
-
ips
array
optional
-

Example response

[
  {
    "id": 0,
    "hostname": "string",
    "ips": [
      "string"
    ]
  }
]
                  

POST /cluster/create

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/cluster/create
                

Example body

{
  "mons": [
    {
      "server": 0,
      "ip": "string"
    }
  ]
}
                

Response 200

result
object
optional
-
statusCode
integer
optional
-
id
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
name
string
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
object
string
optional
-
output
string
optional
-

Example response

{
  "result": {},
  "statusCode": 0,
  "id": 0,
  "done": true,
  "startedAt": 0,
  "startedBy": "string",
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string"
}
                  

GET /cluster/status

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/status
                

Response 200

timestamp
integer
optional
The timestamp at which this status report was created. Note that the Ceph state can be up to 30 seconds older if Ceph is slow to respond.
cephLastUpdated
number
optional
Duration in seconds.
cephStatus
object
optional
-
healthDetails
object
optional
-
placementGroups
array
optional
-
recoveryTimeRemaining
number
optional
Duration in seconds.
servers
object
optional
-
mds
object
optional
-
utilizationByDeviceClass
object
optional
-
radosgws
object
optional
-
iscsi
object
optional
-
nfsGateways
object
optional
-
smbGateways
object
optional
-
licenseActive
boolean
optional
-
licenseValidUntil
number
optional
Duration in seconds.
croitUptime
number
optional
Duration in seconds.

Example response

{
  "timestamp": 0,
  "cephLastUpdated": 0,
  "cephStatus": {
    "fsid": "string",
    "quorumNamesCount": 0,
    "health": {
      "status": "HEALTH_OK",
      "checks": {},
      "mutes": [
        {
          "code": "string",
          "sticky": true,
          "summary": "string",
          "count": 0
        }
      ]
    },
    "osdMap": {
      "numUpOsds": 0,
      "numInOsds": 0,
      "numOsds": 0
    },
    "mgrMap": {
      "available": true,
      "standbysCount": 0
    },
    "pgMap": {
      "bytesUsed": 0,
      "bytesTotal": 0,
      "readBytesSec": 0,
      "writeBytesSec": 0,
      "recoveringBytesPerSec": 0,
      "readOpPerSec": 0,
      "writeOpPerSec": 0,
      "recoveringObjectsPerSec": 0,
      "dataBytes": 0
    },
    "numOfMons": 0
  },
  "healthDetails": {
    "status": "HEALTH_OK",
    "checks": {},
    "mutes": [
      {
        "code": "string",
        "sticky": true,
        "summary": "string",
        "count": 0
      }
    ]
  },
  "placementGroups": [
    {
      "poolName": "string",
      "poolId": 0,
      "total": 0,
      "okay": 0,
      "warn": 0,
      "error": 0
    }
  ],
  "recoveryTimeRemaining": 0,
  "servers": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "mds": {
    "online": 0,
    "total": 0,
    "up": 0
  },
  "utilizationByDeviceClass": {},
  "radosgws": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "iscsi": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "nfsGateways": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "smbGateways": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "licenseActive": true,
  "licenseValidUntil": 0,
  "croitUptime": 0
}
                  

GET /cluster/status/history

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/status/history
                

Response 200

Example response

[
  0
]
                  

GET /cluster/status/history/{timestamp}

Parameters

timestamp
integer
path
Timestamp as returned by /cluster/status/history

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/status/history/{timestamp}
                

Response 200

timestamp
integer
optional
The timestamp at which this status report was created. Note that the Ceph state can be up to 30 seconds older if Ceph is slow to respond.
cephLastUpdated
number
optional
Duration in seconds.
cephStatus
object
optional
-
healthDetails
object
optional
-
placementGroups
array
optional
-
recoveryTimeRemaining
number
optional
Duration in seconds.
servers
object
optional
-
mds
object
optional
-
utilizationByDeviceClass
object
optional
-
radosgws
object
optional
-
iscsi
object
optional
-
nfsGateways
object
optional
-
smbGateways
object
optional
-
licenseActive
boolean
optional
-
licenseValidUntil
number
optional
Duration in seconds.
croitUptime
number
optional
Duration in seconds.

Example response

{
  "timestamp": 0,
  "cephLastUpdated": 0,
  "cephStatus": {
    "fsid": "string",
    "quorumNamesCount": 0,
    "health": {
      "status": "HEALTH_OK",
      "checks": {},
      "mutes": [
        {
          "code": "string",
          "sticky": true,
          "summary": "string",
          "count": 0
        }
      ]
    },
    "osdMap": {
      "numUpOsds": 0,
      "numInOsds": 0,
      "numOsds": 0
    },
    "mgrMap": {
      "available": true,
      "standbysCount": 0
    },
    "pgMap": {
      "bytesUsed": 0,
      "bytesTotal": 0,
      "readBytesSec": 0,
      "writeBytesSec": 0,
      "recoveringBytesPerSec": 0,
      "readOpPerSec": 0,
      "writeOpPerSec": 0,
      "recoveringObjectsPerSec": 0,
      "dataBytes": 0
    },
    "numOfMons": 0
  },
  "healthDetails": {
    "status": "HEALTH_OK",
    "checks": {},
    "mutes": [
      {
        "code": "string",
        "sticky": true,
        "summary": "string",
        "count": 0
      }
    ]
  },
  "placementGroups": [
    {
      "poolName": "string",
      "poolId": 0,
      "total": 0,
      "okay": 0,
      "warn": 0,
      "error": 0
    }
  ],
  "recoveryTimeRemaining": 0,
  "servers": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "mds": {
    "online": 0,
    "total": 0,
    "up": 0
  },
  "utilizationByDeviceClass": {},
  "radosgws": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "iscsi": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "nfsGateways": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "smbGateways": {
    "healthy": true,
    "online": 0,
    "total": 0
  },
  "licenseActive": true,
  "licenseValidUntil": 0,
  "croitUptime": 0
}
                  

GET /cluster/status/detail

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/status/detail
                

Response 200

status
string
optional
[HEALTH_OK, HEALTH_WARN, HEALTH_ERR, HEALTH_UNKNOWN]
checks
object
optional
-
mutes
array
optional
List of muted status checks. null indicates that the current ceph version doesn't support muting status checks.

Example response

{
  "status": "HEALTH_OK",
  "checks": {},
  "mutes": [
    {
      "code": "string",
      "sticky": true,
      "summary": "string",
      "count": 0
    }
  ]
}
                  

POST /cluster/status/mute/{check}

Parameters

check
string
path
-
body
object
optional
Request to mute a health check.

Endpoint

curl -X POST http://mgmt-node:8080/api/cluster/status/mute/{check}
                

Example body

{
  "ttl": 0,
  "sticky": true
}
                

POST /cluster/status/unmute/{check}

Parameters

check
string
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/cluster/status/unmute/{check}
                

GET /cluster/status/nagios

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cluster/status/nagios
                

Response 200

Example response

"string"