Eine Wartungsseite zu einer Subdomain hinzufügen¶

Note

Wenn die optionalen Attribute nicht gesetzt sind, setzt das System einen Standardwert ein.

Note

Wenn Ihre aktuelle Zeit zwischen dem start- und dem end-Datum liegt, wird die Wartungsseite sofort aktiviert.

Note

In der Myra App wird weiterhin der Platzhalter twitter für X verwendet.

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Eintrags gesetzt.

Senden einer POST-Anfrage an den Endpunkt /domain/{domainId}/{vHostName}/maintenances.

Beschreibung¶

Mit der Add-Maintenance-Page-Anfrage fügen Sie einer Subdomain der Organisation eine oder mehrere Wartungsseiten hinzu.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}, Subdomain name {vHostName}

Objekte: MaintenanceVO

Anfrage¶

Um eine Wartungsseite hinzuzufügen, fügen Sie die Domain-ID {domainId} und den Subdomain name {vHostName} dem Pfad der HTTP-Anfrage hinzu.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen einer Wartungsseite erforderlich sind, muss im Body das Objekt MaintenanceVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`fqdn`	Der Name der Subdomain, der die Wartungsseite zugeordnet ist. Um eine Wartungsseite für alle Subdomains hinzuzufügen, geben Sie als Werte des Attributs ALL-<Domain-ID> oder ALL-<domain name> an.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`start`	Das Datum im ISO-8601-Format, ab dem die Wartungsseite aktiviert wird.	`string($date-time)`
`end`	Das Datum im ISO-8601-Format, bis zu dem die Wartungsseite aktiviert ist.	`string($date-time)`
`content`	Der Inhalt der Wartungsseite als HTML. Beachten Sie, dass keine Ressourcen aus der Subdomain eingebunden werden können, die Sie in den Wartungsmodus versetzt haben. Wenn Ihre Wartungsseite Bilder enthält, verwenden Sie eine andere Domain oder inline base64-codierte Bilder.	`string`
`active`	Die Verfügbarkeit der Wartungsseite.	`true` `false`
`defaultPage`	Ein Array mit definierten Standardseiten, die anstelle einer eigenen Inhaltsseite verwendet werden sollen.	Von Myra generierte Standardseite, Link zu einer externen Seite wie Facebook oder X. Es können eine oder mehrere Standardseiten verwendet werden.
`vhostId`	Die ID der Subdomain, der die Wartungsseite zugeordnet ist.	`integer`

Das System gibt als Antwort das Objekt MaintenanceVO mit den Informationen zum neuen Eintrag zurück.

Beispiel¶

Beispiel-Request-Body:

{
  "objectType": "string",
  "fqdn": "string",
  "start": "string",
  "end": "string",
  "content": "string",
  "contentFrom": "string",
  "active": true,
  "defaultPage": "string",
  "vhostId": 0,
  "permissions": "string",
  "comment": "string"
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.