Informationen zu API-Schlüsseln abrufen

Auf dieser Seite wird beschrieben, wie Sie die API-Schlüsselmethoden für Folgendes verwenden:

Hinweis

Die Seite verwendet curl mit dem Befehlszeilentool oauth2l, um Anfragen an die API-Schlüssel-API zu senden. Unter Erste Schritte mit den API-Schlüsseln finden Sie weitere Informationen zur Einrichtung der API.

API-Schlüssel in einem Projekt auflisten

Mit der Methode ListKeys können Sie eine Liste aller Schlüssel eines Google Cloud-Projekts abrufen:

gcurl https://apikeys.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/keys

Wenn der Vorgang erfolgreich war, erhalten Sie eine Antwort ähnlich der folgenden:

{
  "keys": [
    {
      "name": "projects/12345678/locations/global/keys/2885bf87-5b84-47fa-92af-08c3e9337349",
      "displayName": "API key 2",
      "createTime": "2019-05-29T22:07:22.036Z",
      "uid": "2885bf87-5b84-47fa-92af-08c3e9337349",
      "updateTime": "2019-05-29T22:07:22.058623Z",
      "restrictions": {
        "androidKeyRestrictions": {}
      },
      "etag": "zHib8eXEMCxe4ayQEbIaZg=="
    },
    {
      "name": "projects/12345678/locations/global/keys/a4db08b7-5729-4ba9-8c08-f2df493465a1",
      "displayName": "API key 1",
      "createTime": "2019-05-29T22:06:58.844Z",
      "uid": "a4db08b7-5729-4ba9-8c08-f2df493465a1",
      "updateTime": "2019-05-29T22:06:58.855103Z",
      "restrictions": {
        "androidKeyRestrictions": {}
      },
      "etag": "0L5KcPMGoNi53K5+FqPxiw=="
    }
  ]
}

Standardmäßig gibt die Methode ListKeys eine Liste der verwendbaren API-Schlüssel zurück. Fügen Sie einen Abfrageparameter mit filter=state:DELETED hinzu, um die Listenschlüssel anzuzeigen, die zum Löschen markiert wurden :

gcurl https://apikeys.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/keys?filter=state:DELETED

Bei Erfolg erhalten Sie eine Antwort, die in etwa so aussieht:

{
  "keys": [
    {
      "name": "projects/12345678/locations/global/keys/5d3564ad-f08e-48df-b0ca-0f50858ba3f2",
      "displayName": "Key 1",
      "createTime": "2019-06-12T04:47:30.214Z",
      "uid": "5d3564ad-f08e-48df-b0ca-0f50858ba3f2",
      "updateTime": "2021-03-05T22:35:37.387645Z",
      "deleteTime": "2021-03-05T22:35:37.290544Z",
      "etag": "V96UGAyyz+6sUHttzK42pQ=="
    },
    {
      "name": "projects/12345678/locations/global/keys/7ad567fa-c11b-4903-99dc-88f89da7d73a",
      "displayName": "Key 2",
      "createTime": "2019-06-12T00:47:27.778Z",
      "uid": "7ad567fa-c11b-4903-99dc-88f89da7d73a",
      "updateTime": "2021-03-05T22:23:57.002187Z",
      "deleteTime": "2021-03-05T22:23:56.350234Z",
      "etag": "njPE6YjwHlrh6TLyxHibBg=="
    }
  ]
}

Das Feld deleteTime wird gespeichert, wenn der Löschbefehl ausgeführt wurde. Schlüssel werden nach 30 Tagen endgültig gelöscht.

Wenn Ihr Projekt viele API-Schlüssel enthält, sollten Sie die Ergebnisse lieber durchgehen, anstatt alle Schlüssel zurückzugeben. Um die Anzahl oder die Ergebnisse pro Seite zu steuern, fügen Sie den Abfrageparameter pageSize der Anzahl der Ergebnisse hinzu, die zurückgegeben werden sollen:

gcurl https://apikeys.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/keys?pageSize=25

Das Ende der Antwort enthält das Feld nextPageToken. Wenn Sie die nächste Seite mit Ergebnissen abrufen möchten, fügen Sie das Token beim nächsten Aufruf hinzu. Dazu fügen Sie den Abfrageparameter pageToken hinzu:

gcurl 'https://apikeys.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/keys?pageSize=25&pageToken=TOKEN'

Beachten Sie, dass die URL in einfache Anführungszeichen gesetzt werden muss, da & ein spezielles Bash-Zeichen ist.

Metadaten für einen API-Schlüssel abrufen

Rufen Sie die Methode GetKey mit dem Key.name auf, um Metadaten zu einem bestimmten API-Schlüssel abzurufen:

gcurl https://apikeys.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/keys/KEY_ID

Schlüsselstring abrufen

Aus Sicherheitsgründen geben die Methoden ListKeys und GetKey nicht den Wert Key.keyString zurück. Rufen Sie mit der Methode GetKeyString mit Key.name die Methode keyString für einen API-Schlüssel auf:

gcurl https://apikeys.googleapis.com/v2/Key.name/keyString

Der aufrufende Nutzer muss die Berechtigung apikeys.keys.getKeyString haben, um die Methode GetKeyString aufzurufen.

Schlüsselname und Projekt nach Schlüsselstring suchen

Wenn Sie einen keyString verwenden und den Schlüssel name und das Projekt suchen müssen, zu dem der API-Schlüssel gehört, rufen Sie die Methode LookupKey auf und geben Sie den Abfrageparameter keyString an. :

gcurl https://apikeys.googleapis.com/v2/keys:lookupKey?keyString=KEY_STRING

Die Antwort ähnelt dem folgenden Beispiel. 

{
  "parent": "projects/12345678/locations/global",
  "name": "projects/12345678/locations/global/keys/2c437be3-1c77-417b-8f6f-748189760227"
}

In der Antwort:

  • Das Feld parent enthält die Projektnummer des Cloud-Projekts, in dem der API-Schlüssel erstellt wurde.
  • Das Feld name enthält die eindeutige Kennung für den API-Schlüssel.

Nächste Schritte