Aggiungere un dominio alla lista consentita

Questa pagina spiega come aggiungere un dominio alla lista consentita utilizzando l'API Domini inclusi nella lista consentita.

Prima di iniziare

• Leggi la panoramica dell'API Domini inclusi nella lista consentita.
• Configura l'API Domini inclusi nella lista consentita.

Considerazioni principali

• Progettazione immutabile: poiché i nomi di dominio non possono essere modificati, gli aggiornamenti devono essere eseguiti eliminando la voce esistente e creandone una nuova.
• Throughput: il sistema supporta una quota di circa 1 query al secondo (QPS) condivisa tra tutti i domini per qualsiasi account cliente univoco.
• Capacità: gli amministratori possono aggiungere un massimo di 5000 domini per un singolo account cliente.

Aggiungere un dominio alla lista consentita

Utilizza il metodo create per aggiungere una nuova voce. Questa mutazione è asincrona e restituisce un'operazione a lunga esecuzione (LRO).

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

Gestione degli errori

Condizione di errore	Codice di stato RPC	Messaggio di errore	Risoluzione dei problemi / Giustificazione
Non hai l'autorizzazione per la risorsa	PERMISSION_DENIED (403)	"Permission denied for allowlisted domain resource."	• Assicurati che all'utente sia stato concesso l'ambito appropriato. • Assicurati che l'utente disponga dell'autorizzazione richiesta. • Contatta l'indirizzo email di contatto per verificare se il progetto/utente è stato incluso nella lista consentita.
ID cliente non trovato per l'utente	NOT_FOUND (404)	"Customer ID not found for user."	L'utente che ha eseguito l'accesso non è collegato a un dominio valido.
È già in corso un aggiornamento della lista consentita.	FAILED_PRECONDITION (400)	"An allowlist update is already in progress. Please wait for it to complete before making another request."	Attendi il completamento delle mutazioni precedenti.
È stato raggiunto il limite di domini nella lista consentita.	FAILED_PRECONDITION (400)	"Allowlisted domain limit has been reached."	È stata raggiunta la capacità massima di 5000 domini per l'account cliente; non è possibile aggiungere altri domini.
Nome di dominio vuoto	INVALID_ARGUMENT (400)	"Domain name cannot be empty."	Controlla il dominio passato alla richiesta di creazione. Non deve essere vuoto.
Nome di dominio non valido	INVALID_ARGUMENT (400)	"Invalid domain name: <domain>."	Il nome di dominio fornito nella richiesta non è valido o è malformato. Questo errore si verifica in genere in uno dei seguenti scenari: • Non validità sintattica: il nome di dominio non è conforme agli standard di formattazione richiesti. • Domini con limitazioni: i seguenti domini specifici sono soggetti a limitazioni e non possono essere aggiunti alla lista consentita: • aol.com • gmail.com • hotmail.com • mail.ru • outlook.com • web.de • yahoo.com • yandex.com • yandex.ru

Audit log

Le creazioni che utilizzano l'API Domini inclusi nella lista consentita generano eventi dei log di controllo che possono essere esaminati dagli amministratori. Per ulteriori informazioni, vedi Visualizzare i log di controllo.