Vai al contenuto

Gruppi

I gruppi sono una funzionalità visiva utilizzabile dal pannello di ermes per fornire un raggruppamento dei vari server, nonostante ciò possono essere visualizzati e configurati via API.

Creare un Gruppo

Per utilizzare i gruppi per prima cosa occorre crearne uno, per fare ciò è disponibile la seguente richiesta:

Richiesta HTTP

POST /ecs/v2/groups
{
  "notes": "my-faboulus-group", //l'etichetta del tuo gruppo
  "password": "" //il campo password è deprecato ma è necessario nella richiesta per questioni di retrocompatibilità
}

Risposta HTTP

{
  "status": "ok",
  "group": {
    "id": 1,
    "name": "ei000001",
    "notes": "my-faboulus-group",
    "enabled": true
  }
}

Potresti ricevere i seguenti errori:

Status Code Messaggio Spiegazione
400 notes and password are required field sono necessari entrambi i campi per creare un gruppo

Una volta creato un gruppo è possibile aggiungere dei server a esso.

Visualizzare i Gruppi attivi

È possibile visualizzare tutti i gruppi utilizzando la seguente richiesta:

Richiesta HTTP

GET /ecs/v2/groups

Risposta HTTP

{
  "status": "ok",
  "groups": [
    {
    "id": 1,
    "name": "ei000001",
    "notes": "my-faboulus-group",
    "enabled": true
    },
    {
    "id": 2,
    "name": "ei000002",
    "notes": "my-second-faboulus-group",
    "enabled": true
  }
  ]
}

Visualizzare un particolare Gruppo

Per visualizzare un particolare gruppo è disponibile la seguente richiesta:

Richiesta HTTP

GET /ecs/v2/groups/{groupid}

Risposta HTTP

{
  "status": "ok",
  "group": {
    "id": 1,
    "name": "ei000001",
    "notes": "my-faboulus-group",
    "enabled": true
  }
}

Cancellare un Gruppo

Nel caso si voglia cancellare un gruppo è possibile farlo utilizzando la seguente richiesta:

Richiesta HTTP

DELETE /ecs/v2/groups/{groupid}

Risposta HTTP

{
  "status": "ok"
}

Potresti ricevere i seguenti errori:

Status Code Messaggio Spiegazione
400 there are servers joined in this group. Remove join first and than remove group Per rimuovere un gruppo è prima necessario rimuovere ogni server ad esso collegato