Auf dieser Seite wird beschrieben, wie Sie Ihre Entwicklungsumgebung für die Verwendung der Service Usage API einrichten.
- Für die meisten praktischen Anwendungsfälle ist es am einfachsten, die Dienste mit der Google Cloud Console zu aktivieren und zu deaktivieren.
- Wenn Sie Skripts erstellen müssen, können Sie die
gcloud
-Befehlszeile verwenden. - Für die Programmierung unter Einbindung der Service Usage API empfehlen wir eine unserer verfügbaren Clientbibliotheken.
- Um die API auszuprobieren, ohne gleich eine komplette Entwicklungsumgebung für Anwendungen einzurichten, können Sie die alternative Einrichtungsanleitung in diesem Dokument und den
curl
-Befehl verwenden. Einige der in dieser Anleitung verlinkten Ressourcen stehen ggf. nur auf Englisch zur Verfügung.
Direkten API-Aufruf einrichten
In diesem Abschnitt werden die grundlegenden Schritte zum Einrichten Ihrer lokalen Umgebung und zum Testen der Service Usage API mit dem curl
-Befehl beschrieben. Der Abschnitt ist für Entwickler bestimmt, die unter Verwendung der Service Usage API programmieren möchten.
Service Usage API aktivieren
Bevor Sie die Service Usage API für ein Cloud-Projekt verwenden können, müssen Sie sie zuerst in diesem Projekt aktivieren:
- Rufen Sie in der Google Cloud Console die Seite API-Bibliothek auf.
Zur Seite "API-Bibliothek" - Wählen Sie das Cloud-Projekt aus, das Sie für den Zugriff auf den Dienst verwenden möchten.
- Klicken Sie auf der Seite "API-Bibliothek" auf Aktivieren.
Autorisierung konfigurieren
So autorisieren Sie die Service Usage API für den Zugriff auf Ihr Cloud-Projekt:
- Erstellen Sie ein Dienstkonto.
- Rufen Sie in der Cloud Console die Seite Dienstkonten auf.
Zur Seite "Dienstkonten" - Wählen Sie das Cloud-Projekt aus, das Sie für den Zugriff auf den Dienst verwenden möchten.
- Erstellen Sie ein Dienstkonto: Informationen zum Erstellen von Dienstkonten finden Sie unter Dienstkonten erstellen und verwalten.
- Rufen Sie in der Cloud Console die Seite Dienstkonten auf.
- Weisen Sie Ihrem neuen Dienstkonto die Rolle Service Usage-Administrator zu. Informationen zum Zuweisen von Rollen für Dienstkonten finden Sie unter Dienstkonten Rollen zuweisen.
Lokalen Computer konfigurieren
- Rufen Sie in der Cloud Console die Seite API-Anmeldedaten auf.
Zur Seite "API-Anmeldedaten" - Erstellen Sie einen Dienstkontoschlüssel für Ihr neues Dienstkonto und laden Sie die JSON-Datei mit den Anmeldedaten auf Ihren lokalen Computer herunter. In den Beispielen dieses Leitfadens wird davon ausgegangen, dass der Dateipfad
~/credentials.json
ist. Informationen zum Erstellen von Dienstkontoschlüsseln finden Sie unter Dienstkontoschlüssel erstellen und verwalten. - Installieren Sie oauth2l auf Ihrem lokalen Gerät, um mit dem Google OAuth-System zu interagieren.
Optional können Sie mit oauth2l ein Inhabertoken mit Ihrer Datei mit den Anmeldedaten erstellen. Dies überprüft, ob Ihre OAuth-Einrichtung korrekt ist und die Datei mit den Anmeldedaten für Ihr Dienstkonto gültig ist:
oauth2l header --json ~/credentials.json cloud-platform userinfo.email
Bei Erfolg sieht die Ausgabe etwa so aus:
Authorization: Bearer y29.xxxxxxx
- Rufen Sie in der Cloud Console die Seite API-Anmeldedaten auf.
Mit "curl" testen
Definieren Sie ein geeignetes Shell-Alias zum Aufrufen der Google REST APIs:
alias gcurl='curl -H "$(oauth2l header --json ~/credentials.json cloud-platform userinfo.email)" -H "Content-Type: application/json"'
Legen Sie eine Umgebungsvariable
PROJECT_ID
mit der ID Ihres Projekts fest:PROJECT_ID="my-project-id"
Prüfen Sie, ob Sie in "gcloud" angemeldet sind:
gcloud auth login
Verwenden Sie
gcloud
, um die Projektnummer Ihres Projekts zu ermitteln und in einer Umgebungsvariable zu speichern:PROJECT_NUMBER=`gcloud projects list --filter="${PROJECT_ID}" --format="value(PROJECT_NUMBER)"`
Listen Sie die aktivierten APIs und Dienste in diesem Projekt auf:
gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_NUMBER}/services?filter=state:ENABLED&fields=services.config.title,services.config.name"
Wenn Sie eine Ausgabe wie diese sehen, ist die Einrichtung erfolgreich:
{ "services": [ { "config": { "name": "bigquery.googleapis.com", "title": "BigQuery API" } }, { "config": { "name": "bigquerystorage.googleapis.com", "title": "BigQuery Storage API" } }, ...
Tipp
Folgen Sie dem Abschnitt Dienste auflisten, um die APIs und Dienste aufzulisten, die in Ihren Cloud-Projekten aktiviert oder verfügbar sind.