Domains auf der Zulassungsliste auflisten und abrufen

Auf dieser Seite finden Sie Codebeispiele und betriebliche Details, die zeigen, wie Sie mit der Allowlisted Domains API bestimmte Domains auf der Zulassungsliste auflisten und abrufen.

Hinweis

Führen Sie folgende Aufgaben aus, bevor Sie die Informationen auf dieser Seite umsetzen:

Domains auf der Zulassungsliste auflisten

Verwenden Sie die Methode list, um alle Einträge abzurufen. Optional können Sie pageSize, pageToken oder einen filter-String angeben, um die Ergebnisse einzugrenzen.

Python 

def list_allowlisted_domains(
    service, page_size=None, page_token=None, domain_filter=None
):
  """Lists allowlisted domains."""
  try:
    filter_string = None
    if domain_filter:
      filter_string = f"domain = '{domain_filter}'"

    response = (
        service.allowlistedDomains()
        .list(
            pageSize=page_size, pageToken=page_token, filter=filter_string
        )
        .execute()
    )
    return response
  except Exception as e:
    print(f'An error occurred during list: {e}')
    return None

Bestimmte Domain abrufen

Rufen Sie eine bestimmte Domain synchron mit ihrem Ressourcennamen ab, der aus einem vorherigen Listenaufruf stammt.

Python 

def get_allowlisted_domain(service, resource_name):
  """Gets an allowlisted domain."""
  if not resource_name:
    print('Resource name is missing.')
    return None

  try:
    response = service.allowlistedDomains().get(name=resource_name).execute()
    return response
  except Exception as e:
    print(f'An error occurred during get: {e}')
    return None

Fehlerbehandlung

In diesem Abschnitt werden häufige Fehlerbedingungen und Schritte zur Fehlerbehebung beim Auflisten oder Abrufen von Domains auf der Zulassungsliste beschrieben.

Fehlerbehandlung für Listenaufrufe

Fehlerbedingung RPC-Statuscode Fehlermeldung Fehlerbehebung / Begründung
Nicht zur Ressource autorisiert PERMISSION_DENIED (403) "Permission denied for allowlisted domain resource." • Prüfen Sie, ob der Nutzer den entsprechenden Bereich hat.
• Prüfen Sie, ob der Nutzer die erforderliche Berechtigung hat.
• Wenden Sie sich an die Kontakt-E‑Mail-Adresse, um zu prüfen, ob das Projekt/der Nutzer auf der Zulassungsliste steht.
Kundennummer für den Nutzer nicht gefunden NOT_FOUND (404) "Customer ID not found for user." Der angemeldete Nutzer ist nicht mit einer gültigen Domain verknüpft.
Liste während der Paginierung geändert ABORTED "List has been mutated. Please restart pagination." Die zugrunde liegende Liste der Domains wurde geändert, während Sie die Paginierung durchgeführt haben. Sie müssen den Vorgang allowlistedDomains.list auf der ersten Seite neu starten. Wenn parallel Änderungen vorgenommen werden, sollten Sie die vollständige Liste auf einmal abrufen.
Ungültiger Filterwert für die Domain angegeben INVALID_ARGUMENT (400) "Invalid domain filter value provided. Error: <Error message>." Prüfen Sie, ob die im Filterparameter der Listenanfrage angegebene Domain nicht leer oder syntaktisch ungültig ist.
Fälle, in denen ungültige Filterparameter angegeben wurden:
Der allowlistedDomains.list Vorgang ist aufgrund einer ungültigen Syntax oder eines nicht unterstützten Vorgangs im Filter fehlgeschlagen. In der Fehlermeldung wird der genaue Anwendungsfall erläutert. Achten Sie darauf, dass Sie die API im folgenden Format aufrufen:
GET https://cloudidentity.googleapis.com/v1/allowlistedDomains?filter="domain = 'google.com'"
Ungültiger Filterausdruck INVALID_ARGUMENT (400) "Invalid filter expression: %s." In der Anfrage wurde ein falscher Filterausdruck übergeben.
Zusammengesetzte Bedingungen werden nicht unterstützt INVALID_ARGUMENT (400) "Composite conditions (AND, OR, NOT) are not supported in the filter." Der Filter unterstützt keine zusammengesetzten Bedingungen. Es ist nur die Filterung mit einer einzelnen Bedingung zulässig.
Nur der Operator "=" wird unterstützt INVALID_ARGUMENT (400) "Only '=' operator is supported in the filter." Verwenden Sie für alle Filterausdrücke den Gleichheitsoperator (=). Andere Vorgänge werden nicht unterstützt.
Nur das Feld "domain" wird unterstützt INVALID_ARGUMENT (400) "Only 'domain' field is supported in the filter." Der Filter muss auf das Feld „domain“ ausgerichtet sein (z.B. domain = 'example.com'). Andere Felder werden nicht unterstützt.
Die rechte Seite hat einen ungültigen Memberwert / sollte ein String sein INVALID_ARGUMENT (400) "RHS of filter expression has invalid member value."
"RHS of filter expression should be a string."		 Der Wert auf der rechten Seite des Filterausdrucks muss ein String sein (der Domainname).
Seitengröße ist negativ INVALID_ARGUMENT (400) "Page size cannot be negative." Achten Sie darauf, dass der Parameter pageSize eine nicht negative Ganzzahl ist.
Ungültiges Seitentoken INVALID_ARGUMENT (400) "Invalid page token." Der Fehler gibt an, dass das Token fehlerhaft oder abgelaufen ist. Achten Sie darauf, dass Sie das genaue, unveränderte Token verwenden, das vom Feld nextPageToken aus der unmittelbar vorherigen Listenantwort bereitgestellt wurde. Wenn die Validierung fehlschlägt, lassen Sie den Parameter pageToken weg, um die Paginierung auf der ersten Seite neu zu starten.

Fehlerbehandlung für Abrufe

Fehlerbedingung RPC-Statuscode Fehlermeldung Fehlerbehebung / Begründung
Nicht zur Ressource autorisiert PERMISSION_DENIED (403) "Permission denied for allowlisted domain resource." • Prüfen Sie, ob der Nutzer den entsprechenden Bereich hat.
• Prüfen Sie, ob der Nutzer die erforderliche Berechtigung hat.
• Wenden Sie sich an die Kontakt-E‑Mail-Adresse, um zu prüfen, ob das Projekt/der Nutzer auf der Zulassungsliste steht.
Kundennummer für den Nutzer nicht gefunden NOT_FOUND (404) "Customer ID not found for user." Der angemeldete Nutzer ist nicht mit einer gültigen Domain verknüpft.
Domain nicht auf der Zulassungsliste gefunden NOT_FOUND (404) "Allowlisted domain <domain> not found" Die angegebene Domain ist nicht auf der Zulassungsliste vorhanden.
Ressourcenname ist ungültig INVALID_ARGUMENT (400) "Invalid resource name: <resourceName>." Format des Ressourcennamens validieren: Der für den Parameter „name“ verwendete String muss genau dem Format allowlistedDomains/UNIQUE_IDENTIFIER entsprechen.