Nome di dominio personalizzato per REST APIs 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 REST APIs in API Gateway

I nomi di dominio personalizzati sono più semplici e intuitivi URLs che puoi fornire ai tuoi API utenti.

Dopo aver distribuito il tuoAPI, tu (e i tuoi clienti) potete richiamarlo API utilizzando la base predefinita URL del seguente formato: 

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

dove api-id è generato da API Gateway, region è la AWS regione, e stage è specificata dall'utente durante la API distribuzione di.

La parte hostname diURL, si api-id.execute-api.region.amazonaws.com riferisce a un API endpoint. Il nome dell'APIendpoint predefinito viene generato casualmente, è difficile da richiamare e non è intuitivo.

Con i nomi di dominio personalizzati, puoi impostare il tuo hostname e scegliere un percorso API di base (ad esempio,myservice) per mappare l'alternativa al tuo. URL API Ad esempio, una API base più intuitiva URL 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 uso privatoAPIs.

  • Puoi disabilitare l'endpoint predefinito per il tuoAPI. 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 a REST APIs e HTTPAPIs. È possibile utilizzare la versione 2 del API Gateway APIs per creare e gestire nomi di dominio personalizzati regionali per RESTAPIs.

  • 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 DNS provider da mappare all'APIendpoint. Senza tale mappatura, API le richieste associate al nome di dominio personalizzato non possono raggiungere API Gateway.

  • È possibile 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 REST API personalizzato in API Gateway.

  • Per configurare API mappature 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

È necessario disporre di un nome di dominio Internet registrato per configurare nomi di dominio personalizzati per il proprioAPIs. 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 la specifica RFC1035 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 unAPI, è necessario disporre di un TLS certificatoSSL/ACM. Se non ACM è disponibile nella AWS regione in cui si sta creando il nome di dominio personalizzato, è necessario importare un certificato in API Gateway in quella regione.

Per importare un ente di SSL/TLS certificate, you must provide the PEM-formatted SSL/TLS certificazione, la relativa chiave privata e la catena di certificati per il nome di dominio personalizzato.

Ogni certificato memorizzato in ACM è identificato dal suoARN. Con i certificati emessi daACM, 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 relativoARN.

Se l'applicazione utilizza il blocco dei certificati, a volte noto come SSL pinning, per bloccare un ACM certificato, l'applicazione potrebbe non essere in grado di connettersi al dominio dopo il AWS rinnovo del certificato. 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 Wildcard supportano configurazioni diverse dai nomi di dominio personalizzati standard di API Gateway. Ad esempio, in un singolo AWS account, è possibile configurare *.example.com e a.example.com comportarsi in modo diverso.

Puoi utilizzare le variabili di $context.domainPrefix contesto $context.domainName e per determinare il nome di dominio utilizzato da un client per chiamare il tuoAPI. Per ulteriori informazioni sulle variabili di contesto, consulta APIModello di mappatura del gateway e riferimento alla variabile di registrazione degli accessi.

Per creare un nome di dominio personalizzato con caratteri jolly, devi fornire un certificato emesso da ACM che sia stato convalidato utilizzando il metodo di convalida DNS o tramite e-mail.

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 quindi Configura un nome di dominio personalizzato regionale in API Gateway creare un nome di dominio personalizzato regionale.