API für persistente Server

Persistenten Server erstellen

Ein persistenter Server behält eine Serverkonfiguration und skaliert im Gegensatz zu einer Gruppe nicht auf mehrere Instanzen. Die Beispiele verwenden den unter Installation erstellten gemeinsamen CloudApi-Client und gehören in die Methoden deines Plugins. Dieses Beispiel erstellt survival-1 mit einem neuen Paper-Blueprint. Da der persistente Server aktiv ist, startet SimpleCloud seine Instanz und ersetzt sie, nachdem sie gestoppt wurde.

CreatePersistentServerRequest request = CreatePersistentServerRequest.builder()
    .name("survival-1")
    .type(GroupServerType.SERVER)
    .minMemory(2048)
    .maxMemory(4096)
    .maxPlayers(80)
    .createBlueprint(CreateBlueprintRequest.builder()
        .configurator("paper")
        .serverSoftware("paper")
        .minecraftVersion("1.21.11")
        .build())
    .active(true)
    .serverhostId("serverhost-uuid")
    .tags(List.of("survival", "production"))
    .build();

api.persistentServer().createPersistentServer(request)
    .thenAccept(server -> System.out.println(
        "Persistenten Server " + server.getName() + " mit ID " + server.getPersistentServerId() + " erstellt"));

Um stattdessen einen vorhandenen Blueprint zu verwenden, ersetze createBlueprint(...) durch eine Quelle:

.source(SourceConfig.builder()
    .type(SourceType.BLUEPRINT)
    .blueprint("blueprint-uuid")
    .build())

Lege entweder source oder createBlueprint fest, nicht beides.

Felder von CreatePersistentServerRequest

string

erforderlich

Verwende bis zu 100 ASCII-Buchstaben, Ziffern, Unterstriche oder Bindestriche ([A-Za-z0-9_-]). Namen persistenter Server sind innerhalb des Netzwerks eindeutig.Beim Abgleich wird die Groß- und Kleinschreibung nicht berücksichtigt, sodass Survival-1 und survival-1 denselben persistenten Server bezeichnen. Beim Erstellen oder Umbenennen auf eine reine Variante der Groß- und Kleinschreibung gibt die API 409 Conflict zurück.Ein persistenter Server und eine Gruppe dürfen denselben Namen haben.

GroupServerType | null

SERVER oder PROXY. Der Standardwert ist SERVER.

integer | null

Minimaler Arbeitsspeicher in MB.

integer | null

Maximaler Arbeitsspeicher in MB.

integer | null

Spielerlimit. Der Standardwert ist 50.

CreateBlueprintRequest | null

Blueprint, der für diesen persistenten Server erstellt wird.

SourceConfig | null

Vorhandener Blueprint oder vorhandenes Container-Image, der beziehungsweise das verwendet wird. Lege dieses Feld nicht gemeinsam mit createBlueprint fest.

boolean | null

Legt fest, ob SimpleCloud eine Instanz in Betrieb halten soll. Der Standardwert ist true.

integer | null

Priorität des persistenten Servers.

string | null

ID des zugewiesenen Serverhosts.

WorkflowsConfig | null

Lebenszyklus- und manuelle Workflows.

Map<String, Object> | null

Benutzerdefinierte Eigenschaften.

List<String> | null

Tags zum Organisieren und Filtern persistenter Server.

Persistente Server suchen

Suche einen persistenten Server anhand seines Namens oder seiner ID:

api.persistentServer().getPersistentServerByName("survival-1")
    .thenAccept(server -> System.out.println(server.getPersistentServerId()));

api.persistentServer().getPersistentServerById("persistent-server-uuid")
    .thenAccept(server -> System.out.println(server.getName()));

Das zurückgegebene Future schlägt fehl, wenn kein persistenter Server übereinstimmt. Bei der Suche nach Namen wird die Groß- und Kleinschreibung nicht berücksichtigt. Verwende eine Abfrage, um die Liste zu filtern:

PersistentServerQuery query = PersistentServerQuery.create()
    .filterByActive(true)
    .filterByTags("survival", "production")
    .limit(20);

api.persistentServer().getAllPersistentServers(query)
    .thenAccept(servers -> servers.forEach(server ->
        System.out.println(server.getName() + ": " + server.getPlayerCount())));

Die Abfrage kann nach Tags, Aktivierungszustand und Serverhost-ID filtern. Rufe getAllPersistentServers() ohne Abfrage auf, um alle persistenten Server zurückzugeben.

Persistenten Server aktualisieren

Nur die in UpdatePersistentServerRequest festgelegten Felder werden geändert:

UpdatePersistentServerRequest update = UpdatePersistentServerRequest.builder()
    .maxMemory(6144)
    .maxPlayers(100)
    .build();

api.persistentServer()
    .updatePersistentServer("persistent-server-uuid", update)
    .thenAccept(server -> System.out.println("Server " + server.getName() + " aktualisiert"));

Du kannst den Namen, Typ, Arbeitsspeicher, das Spielerlimit, den Aktivierungszustand, die Priorität, den zugewiesenen Serverhost, die Quelle, Workflows, Eigenschaften und Tags aktualisieren.

Eigenschaften verwalten

Verwende die Eigenschaftsmethoden, um benutzerdefinierte Eigenschaften zu ändern, ohne die übrige Konfiguration zu aktualisieren:

api.persistentServer().updatePersistentServerProperties(
    "persistent-server-uuid",
    Map.of("gameMode", "SURVIVAL", "region", "eu-central")
).thenAccept(properties -> System.out.println("Eigenschaften: " + properties));

api.persistentServer()
    .deletePersistentServerProperty("persistent-server-uuid", "region")
    .thenAccept(properties -> System.out.println("Eigenschaften: " + properties));

updatePersistentServerProperties führt die übergebenen Werte mit den vorhandenen Eigenschaften zusammen. Du kannst außerdem eine einzelne Eigenschaft aktualisieren oder mehrere Eigenschaften löschen.

Persistenten Server löschen

api.persistentServer()
    .deletePersistentServer("persistent-server-uuid")
    .thenRun(() -> System.out.println("Persistenten Server gelöscht"));

Deaktiviere den persistenten Server zuerst, stoppe seine Instanz und lösche die Konfiguration, nachdem die Instanz beendet wurde. Die Serverdateien bleiben auf dem Serverhost erhalten.

Modell des persistenten Servers

PersistentServer erweitert ServerBase und stellt die folgenden Felder bereit.

string

erforderlich

Eindeutige ID des persistenten Servers.

string

erforderlich

Name des persistenten Servers.

GroupServerType

erforderlich

SERVER, PROXY oder UNKNOWN_SERVER.

integer | null

Minimaler Arbeitsspeicher in MB.

integer | null

Maximaler Arbeitsspeicher in MB.

integer | null

Spielerlimit.

boolean | null

Legt fest, ob SimpleCloud eine Instanz in Betrieb halten soll.

integer | null

Priorität des persistenten Servers.

string | null

ID des zugewiesenen Serverhosts.

integer

erforderlich

Aktuelle Spieleranzahl oder 0, wenn keine Instanz läuft.

SourceConfig | null

Blueprint- oder Container-Image-Quelle.

WorkflowsConfig | null

Lebenszyklus- und manuelle Workflows.

Map<String, Object> | null

Benutzerdefinierte Eigenschaften.

List<String> | null

Tags zum Filtern und Organisieren.

string

erforderlich

Erstellungszeitpunkt im ISO-8601-Format.

string

erforderlich

Zeitpunkt der letzten Aktualisierung im ISO-8601-Format.

Verwende api.server(), um mit der laufenden Instanz zu arbeiten. Die Methode getPersistentServerId() verknüpft sie mit dieser Konfiguration.

Getting Started

Cloud API

Guides

API für persistente Server

Persistenten Server erstellen

Persistente Server suchen

Persistenten Server aktualisieren

Eigenschaften verwalten

Persistenten Server löschen

Modell des persistenten Servers

​Persistenten Server erstellen

​Persistente Server suchen

​Persistenten Server aktualisieren

​Eigenschaften verwalten

​Persistenten Server löschen

​Modell des persistenten Servers

Persistenten Server erstellen

Persistente Server suchen

Persistenten Server aktualisieren

Eigenschaften verwalten

Persistenten Server löschen

Modell des persistenten Servers