Umgang mit Anfragen an den Open Cloud-Datenbankdienst

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Es gibt mehrere Überlegungen zum Senden von Anfragen und zum Umgang mit Antworten von den Open Cloud-Datenbank-APIs.

HTTP-Header

Wie bei allen Open Cloud-Endpunkten müssen Datenbankanforderungen, die die Authentifizierung über API-Schlüssel verwenden, den Header x-api-key enthalten. Weitere Informationen finden Sie unter API-Schlüssel verwalten.

Ein falscher oder fehlender API-Schlüssel führt zu einem 401-Fehler.
Ein gültiger API-Schlüssel, dem die richtigen Berechtigungen fehlen, führt zu einem 403-Fehler.

Wenn eine Anfrage einen Body enthält, wie z. B. bei Erstellungs- oder Aktualisierungsanfragen, fügen Sie die Header Content-Type: application/json und Content-Length hinzu. Die meisten Clients fügen diese Header automatisch hinzu.

Seitenpagination

Datenbanken enthalten häufig viele Einträge, was bedeutet, dass Ihr Code, insbesondere beim Aufrufen von List Data Store Entries, mit einer maximalen Anzahl von Ergebnissen und Seiten umgehen muss. Weitere Informationen finden Sie unter Paginierung.

Filter

Wenn Sie Präfixe in den Namen Ihrer Datenbankeinträge verwenden, möchten Sie wahrscheinlich Ihre GET-Aufrufe filtern, wie folgt:


def list_entries(universe, data_store, filter):
    list_path = f'universes/{universe}/data-stores/{data_store}/entries'
    url = base_url + list_path
    return requests.get(url, params={'filter': f'id.startsWith("global/{filter}")'}, headers={apiHeaderKey: apiKey})

Die Filter-Syntax ist äußerst eingeschränkt. Siehe die Referenzdokumentation für verfügbare Filter für standard und geordnet Datenbanken.

Fehlende Flags zulassen

Die PATCH (Aktualisierung) Methoden für Standard- und geordnete Datenbanken haben einen Parameter allow_missing. Wenn auf true gesetzt, erlaubt dieser Parameter das Erstellen von Einträgen, die noch nicht existieren, anstatt einen Fehler auszulösen. Lassen Sie diesen Parameter auf seinem Standardwert false, es sei denn, Sie haben einen guten Grund dafür; die Aktualisierung eines Eintrags, der nie erstellt wurde, stellt oft einen Fehler in der Programmierlogik dar.

Bereiche

Viele Anfragen erfordern, dass Sie einen Bereich angeben, auch wenn es der Standardwert global ist. Diese Bereiche sind von Berechtigungsbereichen unterschiedlich und ermöglichen es Ihnen, die Einträge in einer Datenbank zu unterteilen und zu organisieren.

Statt nicht-standardisierte Bereiche zu erstellen, empfehlen wir dringend, Präfixe zu verwenden. Weitere Informationen finden Sie unter Auflistung und Präfixe.

Content-MD5

Dieser Abschnitt gilt nur für die Open Cloud v1 API.

Die Open Cloud v1 API unterstützt eine optionale base64-kodierte MD5-Prüfziffer in einigen Anfragen, die Datenintegritätsprobleme erkennen kann. Viele Programmiersprachen verfügen über integrierte Funktionen zur Berechnung des Wertes des Headers content-md5. Das folgende Beispiel verwendet Python:


$ echo "750" | python -c "import base64, hashlib; print(str(base64.b64encode(hashlib.md5(bytes(input(), encoding='utf8')).digest()), encoding='utf8'))"
sTf90fedVsft8zZf6nUg8g==

Wenn Sie Probleme mit der Generierung eines gültigen content-md5 Wertes haben, müssen Sie möglicherweise Ihren Anfrage-Body in UTF-8 kodieren, bevor Sie die Prüfziffer berechnen.

Deutsch