Nome di dominio personalizzato per le API REST in API Gateway - Amazon API Gateway
ConsiderazioniPrerequisiti Nomi di dominio personalizzati con caratteri jollyPassaggi successivi per i nomi di dominio personalizzati

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Nome di dominio personalizzato per le API REST in API Gateway

I nomi di dominio personalizzati sono URL più semplici e più intuitivi che è possibile fornire agli utenti delle API.

Dopo aver distribuito un'API, tu e i tuoi clienti potete richiamarla usando l'URL di base predefinito nel formato seguente: 

https://api-id.execute-api.region.amazonaws.com/stage

dove l'api-id è generato da API Gateway, la regione è la AWS regione e la fase viene specificata dall'utente al momento della distribuzione dell'API.

La parte dell'URL relativa al nome host api-id.execute-api.region.amazonaws.com si riferisce a un endpoint API. Il nome dell'endpoint dell'API predefinito viene generato in modo casuale, è difficile da richiamare e non è intuitivo.

Con i nomi di dominio personalizzati, è possibile impostare il nome host dell'API e scegliere un percorso base (ad esempio myservice) per mappare l'URL alternativo all'API. Ad esempio, un URL di base dell'API più intuitivo può diventare:

https://api.example.com/myservice

Considerazioni

Le seguenti considerazioni potrebbero influire sull'utilizzo di un nome di dominio personalizzato.

  • I nomi di dominio personalizzati non sono supportati per le API private.

  • Puoi disabilitare l'endpoint predefinito per la tua API. I client possono comunque connettersi all'endpoint predefinito, ma riceveranno un codice di stato 403 Forbidden.

  • Un nome di dominio personalizzato regionale può essere associato alle API REST e alle API HTTP. Puoi utilizzare le API API Gateway versione 2 per creare e gestire nomi di dominio personalizzati regionali per le API REST.

  • Un nome di dominio personalizzato deve essere univoco all'interno di una regione per tutti gli AWS account.

  • Puoi eseguire la migrazione di un nome di dominio personalizzato tra endpoint ottimizzati per edge ed endpoint regionali.

  • È necessario creare o aggiornare il record di risorse del provider DNS da mappare all'endpoint API. In assenza di questa mappatura, le richieste API destinate al nome di dominio personalizzato non possono raggiungere API Gateway.

  • Puoi supportare un numero quasi infinito di nomi di dominio senza superare la quota predefinita utilizzando un certificato wildcard. Per ulteriori informazioni, consulta Nomi di dominio personalizzati con caratteri jolly.

  • Puoi scegliere una politica di sicurezza per il tuo nome di dominio personalizzato. Per ulteriori informazioni, consulta Scegli una politica di sicurezza per il tuo dominio personalizzato dell'API REST in API Gateway.

  • Per configurare le mappature delle API con più livelli, è necessario utilizzare un nome di dominio personalizzato regionale e utilizzare la politica di sicurezza TLS 1.2.

Prerequisiti

Di seguito sono riportati i prerequisiti per la creazione di un nome di dominio personalizzato.

Registrare un nome di dominio

Per configurare nomi di dominio personalizzati per le API, devi avere un nome di dominio Internet registrato. Puoi registrare il tuo nome di dominio Internet utilizzando Amazon Route 53 o utilizzando un registrar di domini di terze parti a tua scelta. Il tuo nome di dominio personalizzato può essere il nome di un sottodominio o il dominio principale (noto anche come «apice di zona») di un dominio Internet registrato.

Il nome di dominio deve seguire le specifiche RFC 1035 e può avere un massimo di 63 ottetti per etichetta e 255 ottetti in totale.

Specificate il certificato per il vostro nome di dominio personalizzato

Prima di configurare un nome di dominio personalizzato per un'API, devi disporre di un certificato SSL/TLS pronto in ACM. Se ACM non è disponibile nella AWS regione in cui stai creando il tuo nome di dominio personalizzato, devi importare un certificato in API Gateway in quella regione.

Per importare un certificato SSL/TLS, devi fornire il corpo del certificato SSL/TLS in formato PEM, la sua chiave privata e la catena di certificati per il nome di dominio personalizzato.

Ogni certificato archiviato in ACM è identificato dal relativo ARN. Con i certificati emessi da ACM, non devi preoccuparti di esporre dettagli sensibili del certificato, come la chiave privata. Per utilizzare un certificato AWS gestito per un nome di dominio, è sufficiente fare riferimento al relativo ARN.

Se l'applicazione utilizza il blocco dei certificati, a volte noto come pinning SSL, per bloccare un certificato ACM, l'applicazione potrebbe non essere in grado di connettersi al dominio dopo il rinnovo del certificato. AWS Per ulteriori informazioni, consulta Probemi nel blocco dei certificati nella Guida per l'utente di AWS Certificate Manager .

Nomi di dominio personalizzati con caratteri jolly

Con i nomi di dominio personalizzati con caratteri jolly, è possibile supportare un numero quasi infinito di nomi di dominio senza superare la quota predefinita. Ad esempio, è possibile dare a ciascuno dei clienti il proprio nome di dominio, customername.api.example.com.

Per creare un nome di dominio personalizzato con caratteri jolly, specificare un carattere jolly (*) come primo sottodominio di un dominio personalizzato che rappresenta tutti i possibili sottodomini di un dominio radice.

Ad esempio, il nome di dominio personalizzato con caratteri jolly *.example.com genera sottodomini quali a.example.com, b.example.com e c.example.com, indirizzati tutti allo stesso dominio.

I nomi di dominio personalizzati con caratteri jolly supportano configurazioni distinte dai nomi di dominio personalizzati standard di API Gateway. Ad esempio, in un singolo AWS account, è possibile configurare e comportarsi in modo diverso. *.example.com a.example.com

È possibile utilizzare le variabili di contesto $context.domainName e $context.domainPrefix per determinare il nome di dominio utilizzato da un client per chiamare l'API. Per ulteriori informazioni sulle variabili di contesto, consulta Informazioni di riferimento sui modelli di mappatura e sulle variabili di logging degli accessi in API Gateway.

Per creare un nome di dominio personalizzato con caratteri jolly, è necessario fornire un certificato emesso da ACM che sia stato convalidato utilizzando il DNS o il metodo di convalida della posta elettronica.

Nota

Non puoi creare un nome di dominio personalizzato con caratteri jolly se un altro AWS account ha creato un nome di dominio personalizzato che è in conflitto con il nome di dominio personalizzato con caratteri jolly. Ad esempio, se l'account A ha creato a.example.com, l'account B non può creare il nome di dominio personalizzato con caratteri jolly *.example.com.

Se l'account A e l'account B condividono un proprietario, è possibile contattare il Centro assistenza AWS per richiedere un'eccezione.

Passaggi successivi per i nomi di dominio personalizzati

Di seguito sono riportati i passaggi successivi per i nomi di dominio personalizzati:

Passaggi successivi

Se è la prima volta che crei un nome di dominio personalizzato, ti consigliamo di iniziare conPrepara i certificati in AWS Certificate Manager, specificare il certificato e poi Configura un nome di dominio personalizzato regionale in API Gateway creare un nome di dominio personalizzato regionale.