services

Manage services, this includes both Ceph services and croit-specific services running on both the ceph servers and management node.

GET /services

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/services
                

Response 200

id
string
optional
-
type
string
optional
[osd, mon, mgr, radosgw, mds, nfs_gateway, iscsi, smb, unknown]
state
string
optional
[creating, enabled, disabled, creation_failed]
subState
string
optional
[ACTIVE, STANDBY]
mdsInfo
object
optional
-
server
integer
optional
-
ip
string
optional
-
running
boolean
optional
-
multiServer
array
optional
-
health
object
optional
Health information about a running service

Example response

[
  {
    "id": "string",
    "type": "osd",
    "state": "creating",
    "subState": "ACTIVE",
    "mdsInfo": {
      "filesystemId": 0,
      "rank": 0,
      "name": "string",
      "status": "string"
    },
    "server": 0,
    "ip": "string",
    "running": true,
    "multiServer": [
      0
    ],
    "health": {
      "uptime": 0,
      "memory": 0
    }
  }
]
                  

DELETE /services/{serviceId}

Parameters

serviceId
integer
path
-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/services/{serviceId}
                

POST /services/{type}/{id}/start

Parameters

type
string
path
[osds, mons, radosgws, mds, mgrs, nfs_gateways, iscsis, smbs]
id
integer
path
-
server
integer
query
optional
Required for multi-server services

Endpoint

curl -X POST http://mgmt-node:8080/api/services/{type}/{id}/start?server=0
                

POST /services/{type}/{id}/stop

Parameters

type
string
path
[osds, mons, radosgws, mds, mgrs, nfs_gateways, iscsis, smbs]
id
integer
path
-
server
integer
query
optional
Required for multi-server services

Endpoint

curl -X POST http://mgmt-node:8080/api/services/{type}/{id}/stop?server=0
                

POST /services/{type}/{id}/restart

Parameters

type
string
path
[osds, mons, radosgws, mds, mgrs, nfs_gateways, iscsis, smbs]
id
integer
path
-
server
integer
query
optional
Required for multi-server services

Endpoint

curl -X POST http://mgmt-node:8080/api/services/{type}/{id}/restart?server=0
                

POST /services/start

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/services/start
                

Example body

[
  {
    "type": "osds",
    "id": 0,
    "server": 0
  }
]
                

POST /services/stop

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/services/stop
                

Example body

[
  {
    "type": "osds",
    "id": 0,
    "server": 0
  }
]
                

POST /services/restart

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/services/restart
                

Example body

[
  {
    "type": "osds",
    "id": 0,
    "server": 0
  }
]
                

POST /services/rolling-restart

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/services/rolling-restart
                

Example body

[
  {
    "type": "osds",
    "id": 0,
    "server": 0
  }
]
                

Response 200

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

Example response

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