Auf dieser Seite wird beschrieben, wie Sie mithilfe von Service Infrastructure den Status von verwalteten Diensten, Diensterstellern, Dienstnutzern und API-Schlüsseln überprüfen.
Wenn ein Dienstersteller seinen Dienstnutzern einen Dienst anbietet, muss er darauf achten, dass verschiedene Voraussetzungen erfüllt sind. Beispiele:
- Ein Dienstnutzer wurde gelöscht.
- Der Dienstnutzer hat den Dienst aktiviert.
- Ein API-Schlüssel ist gültig.
Die Service Control API bietet die einfache Methode services.check, um solche Voraussetzungen zu überprüfen. Diese Methode sollte von einem verwalteten Dienst regelmäßig aufgerufen werden, um zu bestätigen, dass die Voraussetzungen auch erfüllt sind. Die Aktivität zwischen dem Dienstersteller und dem Dienstnutzer wird durch einen Operation dargestellt.
Die Methode services.check führt die folgenden Überprüfungen des Vorgangs durch:
- Das Diensterstellerprojekt ist live und voll funktionsfähig.
- Das Dienstnutzerprojekt ist live und voll funktionsfähig.
- Der verwaltete Dienst ist für das Dienstnutzerprojekt aktiviert.
- Der API-Schlüssel ist gültig.
- Durch die Nutzung des API-Schlüssels werden Einschränkungen in Verbindung mit dem API-Schlüssel erfüllt, zum Beispiel IP- oder HTTP-Verweiseinschränkungen.
Die Methode services.check wird normalerweise von den Servern aufgerufen, die den Dienst implementieren. Aus Sicherheits- und Datenschutzgründen prüft die Service Control API mit der Identitäts- und Zugriffsverwaltung, ob der Aufrufer die entsprechende Berechtigung für den Aufruf der Methode hat. Einzelheiten finden Sie unter Zugriffssteuerung für die Service Control API.
Status prüfen
Nach dem Rollout eines verwalteten Dienstes können Sie die Methode services.check für den Dienst ohne weitere Konfiguration aufrufen. Weitere Informationen finden Sie in der Referenz zu services.check.
Rufen Sie mit dem Befehl gcurl die Methode services.check auf, um schnell mit der Methode zu experimentieren. Die Schritte zur Ersteinrichtung werden unter Erste Schritte mit der Service Control API erläutert.
gcurl -d '{
"operation": {
"operationId": "123e4567-e89b-12d3-a456-426655440000",
"consumerId": "project:endpointsapis-consumer",
"startTime":"2016-07-31T05:20:00Z",
"operationName":"google.example.hello.v1.HelloService.GetHello"
}
}' https://servicecontrol.googleapis.com/v1/services/endpointsapis.appspot.com:check
{
"operationId": "123e4567-e89b-12d3-a456-426655440000"
}
Die Antwort der Prüfmethode zeigt, ob alle Prüfungen erfolgreich waren oder Prüfungen fehlgeschlagen sind. Eine erfolgreiche Ausführung ist daran zu erkennen, dass das Feld checkErrors nicht vorhanden ist. Andernfalls werden im Feld checkErrors die fehlgeschlagenen Prüfungen aufgelistet.