Configuración de nombres de dominio personalizados para API HTTP - Amazon API Gateway

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Configuración de nombres de dominio personalizados para API HTTP

Losnombres de dominio personalizados son direcciones URL más sencillas e intuitivas que puede proporcionar a los usuarios de la API.

Después de implementar la API, usted (y sus clientes) puede invocar la API utilizando la URL base predeterminada con el siguiente formato:

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

dónde api-id lo genera API Gateway, region (AWS región) lo especificas al crear la API y stage lo especificas al implementar la API.

La parte del nombre de host de la URL (es decir, api-id.execute-api.region.amazonaws.com) hace referencia a un punto de enlace de la API. El punto de enlace de la API predeterminado puede ser difícil de recordar y no es muy descriptivo.

Con los nombres de dominio personalizados, puede configurar el nombre de host de la API y elegir una ruta base (por ejemplo, myservice) para asignarle una URL alternativa. Por ejemplo, una URL base de la API más simple puede ser:

https://api.example.com/myservice
nota

Los dominios personalizados se pueden asociar con API de REST y API HTTP. Puede utilizar las API de API Gateway versión 2 para crear y administrar nombres de dominio regionales personalizados para API de REST y API HTTP.

Para las API HTTP, TLS 1.2 es la única versión de TLS admitida.

Registrar un nombre de dominio

Debe disponer de un nombre de dominio de Internet registrado para poder crear nombres de dominio personalizados para sus API. Si es necesario, puede registrar un dominio de Internet con Amazon Route 53 o un registrador de dominios de un tercero de su elección. Un nombre de dominio personalizado de la API puede ser el nombre de un subdominio o el dominio raíz (lo que recibe el nombre de "ápex de zona") de un dominio de Internet registrado.

Después de crear un nombre de dominio personalizado en API Gateway, debe crear o actualizar el registro de recursos del proveedor de DNS para asignarlo al punto de enlace de la API. Si no se realiza este mapeo, las solicitudes de API vinculadas al nombre de dominio personalizado no pueden llegar a API Gateway.

Nombres de dominio personalizados regionales

Cuando se crea un nombre de dominio personalizado para una API de región, API Gateway crea un nombre de dominio de región para la API. Debe establecer un registro DNS para asignar el nombre de dominio personalizado al nombre de dominio regional. También debe proporcionar un certificado para el nombre de dominio personalizado.

Nombres de dominio personalizados comodín

Con los nombres de dominio personalizados comodín, puede admitir un número casi infinito de nombres de dominio sin exceder el límite predeterminado. Por ejemplo, puede dar a cada uno de los clientes su propio nombre de dominio, customername.api.example.com.

Para crear un nombre de dominio personalizado comodín, especifique un comodín (*) como primer subdominio de un dominio personalizado que represente todos los subdominios posibles de un dominio raíz.

Por ejemplo, el nombre de dominio personalizado comodín *.example.com produce subdominios como a.example.com, b.example.com y c.example.com, que enrutan al mismo dominio.

Los nombres de dominio personalizados comodín admiten configuraciones distintas de los nombres de dominio personalizados estándar de API Gateway. Por ejemplo, en una sola AWS cuenta, puede configurarla *.example.com y a.example.com comportarse de forma diferente.

Para crear un nombre de dominio personalizado comodín, debe proporcionar un certificado emitido por ACM que se haya validado utilizando el método DNS o de validación de correo electrónico.

nota

No puedes crear un nombre de dominio personalizado con carácter comodín si otra AWS cuenta ha creado un nombre de dominio personalizado que entra en conflicto con el nombre de dominio personalizado con comodín. Por ejemplo, si la cuenta A ha creado a.example.com, la cuenta B no puede crear el nombre de dominio personalizado comodín *.example.com.

Si la cuenta A y la cuenta B comparten un propietario, puede contactar con el Centro de soporte de AWS para solicitar una excepción.

Certificados para nombres de dominio personalizados

importante

Se especifica el certificado para el nombre de dominio personalizado. Si tu aplicación utiliza la fijación de certificados, también conocida como fijación SSL, para fijar un certificado ACM, es posible que la aplicación no pueda conectarse a tu dominio después de renovar el certificado. AWS Para obtener más información, consulte Problemas de asignación de certificados en la Guía del usuario de AWS Certificate Manager .

Para proporcionar un certificado para un nombre de dominio personalizado en una región donde se admita ACM, debe solicitar a ACM un certificado. Para proporcionar un certificado para un nombre de dominio personalizado de región en una región donde no se admita ACM, debe importar un certificado en API Gateway en esa región.

Para importar un certificado SSL/TLS, debe proporcionar el cuerpo del certificado SSL/TLS con formato PEM, su clave privada y la cadena de certificados para el nombre de dominio personalizado. Los certificados almacenados en ACM se identifican mediante su ARN. Para usar un certificado AWS administrado para un nombre de dominio, basta con hacer referencia a su ARN.

ACM facilita la configuración y el uso de un nombre de dominio personalizado para una API. El usuario crea un certificado para el nombre de dominio dado (o importa un certificado), configura el nombre de dominio en API Gateway con el ARN del certificado proporcionado por ACM y asigna una ruta base bajo el nombre de dominio personalizado a una etapa implementada de la API. Con los certificados emitidos por ACM no tiene que preocuparse de si se exponen datos del certificado confidenciales, como la clave privada.

Para obtener información detallada sobre la configuración de un nombre de dominio personalizado, consulte Preparación de certificados en AWS Certificate Manager y Configuración de un nombre de dominio regional personalizado en API Gateway.