cluster
Cluster operations, from initial setup to status.
post /cluster
Parameters body object
{
"ip": "string",
"ipv6": true,
"diskId": 0,
"serverId": 0
}Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"question": {
"token": "string",
"message": "string",
"timeout": 0,
"priority": "Standard",
"timeLeft": 0,
"defaultResponse": "string",
"responseOptions": [
"string"
]
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0,
"interactive": true
}post /cluster/create
Parameters body object
{
"mons": [
{
"ip": "string",
"server": 0
}
]
}Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}get /cluster/status
Responses
200 successful operation
ClusterStatus object
A croit cluster status report consisting of two parts: information about croit-related services and general Ceph services. Both states are gathered independently so you still get information about croit services if your Ceph cluster is down.
{
"mds": {
"total": 0,
"active": 0,
"standby": 0,
"standbyReplay": 0
},
"iscsi": {
"total": 0,
"online": 0,
"healthy": true
},
"servers": {
"total": 0,
"online": 0,
"healthy": true
},
"radosgws": {
"total": 0,
"online": 0,
"healthy": true
},
"timestamp": 0,
"cephStatus": {
"fsid": "string",
"pgMap": {
"bytesUsed": 0,
"dataBytes": 0,
"bytesTotal": 0,
"readBytesSec": 0,
"readOpPerSec": 0,
"writeBytesSec": 0,
"writeOpPerSec": 0,
"recoveringBytesPerSec": 0,
"recoveringObjectsPerSec": 0
},
"health": {
"mutes": [
{
"code": "string",
"count": 0,
"sticky": true,
"summary": "string"
}
],
"checks": {
"additionalProp1": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp2": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp3": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
}
},
"status": "HEALTH_OK"
},
"mgrMap": {
"available": true,
"standbysCount": 0
},
"osdMap": {
"numOsds": 0,
"numInOsds": 0,
"numUpOsds": 0
},
"numOfMons": 0,
"quorumNamesCount": 0
},
"croitUptime": 0,
"nfsGateways": {
"total": 0,
"online": 0,
"healthy": true
},
"smbGateways": {
"total": 0,
"online": 0,
"healthy": true
},
"healthDetails": {
"mutes": [
{
"code": "string",
"count": 0,
"sticky": true,
"summary": "string"
}
],
"checks": {
"additionalProp1": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp2": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp3": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
}
},
"status": "HEALTH_OK"
},
"licenseActive": true,
"nvmeofGateways": {
"total": 0,
"online": 0,
"healthy": true
},
"cephLastUpdated": 0,
"placementGroups": [
{
"okay": 0,
"warn": 0,
"error": 0,
"total": 0,
"poolId": 0,
"inactive": 0,
"poolName": "string"
}
],
"licenseValidUntil": 0,
"recoveryTimeRemaining": 0,
"utilizationByDeviceClass": {
"additionalProp1": {
"size": 0,
"used": 0,
"sizeMax": 0,
"usedMax": 0
},
"additionalProp2": {
"size": 0,
"used": 0,
"sizeMax": 0,
"usedMax": 0
},
"additionalProp3": {
"size": 0,
"used": 0,
"sizeMax": 0,
"usedMax": 0
}
}
}get /cluster/releases
Responses
200 successful operation
CephReleases object
{
"mds": [
{
"count": 0,
"release": "LUMINOUS"
}
],
"mgr": [
{
"count": 0,
"release": "LUMINOUS"
}
],
"mon": [
{
"count": 0,
"release": "LUMINOUS"
}
],
"osd": [
{
"count": 0,
"release": "LUMINOUS"
}
],
"other": {
"additionalProp1": [
{
"count": 0,
"release": "LUMINOUS"
}
],
"additionalProp2": [
{
"count": 0,
"release": "LUMINOUS"
}
],
"additionalProp3": [
{
"count": 0,
"release": "LUMINOUS"
}
]
},
"overall": [
{
"count": 0,
"release": "LUMINOUS"
}
]
}get /cluster/create/mons
Responses
200 successful operation
InitialMonServer array
InitialMonServer object
[
{
"id": 0,
"ips": [
"string"
],
"hostname": "string"
}
]get /cluster/status/detail
Responses
200 successful operation
CephStatusHealth object
{
"mutes": [
{
"code": "string",
"count": 0,
"sticky": true,
"summary": "string"
}
],
"checks": {
"additionalProp1": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp2": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp3": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
}
},
"status": "HEALTH_OK"
}get /cluster/status/nagios
Responses
200 successful operation
string
get /cluster/status/history
List available past cluster state timestamps.
Responses
200 successful operation
array
integer
[
0
]post /cluster/status/mute/{check}
Parameters check string path Required
body object
Request to mute a health check.
{
"ttl": 0,
"sticky": true
}Responses
default successful operation
get /cluster/status/nagios/{check}
Parameters check string path Required
Responses
200 successful operation
string
post /cluster/status/unmute/{check}
Parameters check string path Required
Responses
default successful operation
get /cluster/status/history/{timestamp}
Get cluster state as close as possible to a specific timestamp.
Parameterstimestamp integer path Required
Timestamp as returned by /cluster/status/history
Responses
200 successful operation
ClusterStatus object
A croit cluster status report consisting of two parts: information about croit-related services and general Ceph services. Both states are gathered independently so you still get information about croit services if your Ceph cluster is down.
{
"mds": {
"total": 0,
"active": 0,
"standby": 0,
"standbyReplay": 0
},
"iscsi": {
"total": 0,
"online": 0,
"healthy": true
},
"servers": {
"total": 0,
"online": 0,
"healthy": true
},
"radosgws": {
"total": 0,
"online": 0,
"healthy": true
},
"timestamp": 0,
"cephStatus": {
"fsid": "string",
"pgMap": {
"bytesUsed": 0,
"dataBytes": 0,
"bytesTotal": 0,
"readBytesSec": 0,
"readOpPerSec": 0,
"writeBytesSec": 0,
"writeOpPerSec": 0,
"recoveringBytesPerSec": 0,
"recoveringObjectsPerSec": 0
},
"health": {
"mutes": [
{
"code": "string",
"count": 0,
"sticky": true,
"summary": "string"
}
],
"checks": {
"additionalProp1": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp2": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp3": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
}
},
"status": "HEALTH_OK"
},
"mgrMap": {
"available": true,
"standbysCount": 0
},
"osdMap": {
"numOsds": 0,
"numInOsds": 0,
"numUpOsds": 0
},
"numOfMons": 0,
"quorumNamesCount": 0
},
"croitUptime": 0,
"nfsGateways": {
"total": 0,
"online": 0,
"healthy": true
},
"smbGateways": {
"total": 0,
"online": 0,
"healthy": true
},
"healthDetails": {
"mutes": [
{
"code": "string",
"count": 0,
"sticky": true,
"summary": "string"
}
],
"checks": {
"additionalProp1": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp2": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
},
"additionalProp3": {
"muted": true,
"detail": [
{
"message": "string"
}
],
"summary": {
"count": 0,
"message": "string"
},
"severity": "HEALTH_OK"
}
},
"status": "HEALTH_OK"
},
"licenseActive": true,
"nvmeofGateways": {
"total": 0,
"online": 0,
"healthy": true
},
"cephLastUpdated": 0,
"placementGroups": [
{
"okay": 0,
"warn": 0,
"error": 0,
"total": 0,
"poolId": 0,
"inactive": 0,
"poolName": "string"
}
],
"licenseValidUntil": 0,
"recoveryTimeRemaining": 0,
"utilizationByDeviceClass": {
"additionalProp1": {
"size": 0,
"used": 0,
"sizeMax": 0,
"usedMax": 0
},
"additionalProp2": {
"size": 0,
"used": 0,
"sizeMax": 0,
"usedMax": 0
},
"additionalProp3": {
"size": 0,
"used": 0,
"sizeMax": 0,
"usedMax": 0
}
}
}