Подключить домен
Вы можете подключить собственный домен для обращения к API-шлюзу. К API-шлюзу можно подключить wildcard-домен, например *.example.com, чтобы API-шлюз обрабатывал запросы на все поддомены example.com, или несколько доменов. Домен будет идентифицироваться по заголовку Host.
Важно
Если вашим доменом управляет сторонний DNS-провайдер, домен должен быть ниже второго уровня. Например, можно подключить домен www.example.com, а example.com — нельзя. Это связано с особенностями обработки CNAME-записей на DNS-хостингах. Подробнее в RFC 1912, пункт 2.4.
Чтобы использовать домен второго уровня (example.com), делегируйте его Yandex Cloud DNS и создайте ANAME-запись в зоне DNS.
Чтобы подключить домен к API-шлюзу:
-
Разместите у своего DNS-провайдера или на собственном DNS-сервере CNAME-запись:
<домен> IN CNAME <служебный_домен_API-шлюза>Чтобы узнать служебный домен API-шлюза:
- Перейдите в консоль управления.
- Выберите каталог, в котором находится API-шлюз, и в списке сервисов — API Gateway.
- Выберите API-шлюз.
- Служебный домен будет в поле Служебный домен.
Доменные имена должны заканчиваться точкой.
Чтобы использовать домен выше второго уровня, делегируйте его Yandex Cloud DNS и создайте ANAME-запись в зоне DNS. Создать запись в Yandex Cloud DNS можно не только до, но и после создания домена. См. шаг 6.
-
В консоли управления выберите каталог, в котором находится API-шлюз.
-
В списке сервисов выберите Certificate Manager и в нем:
-
Добавьте сертификат от Let's Encrypt® или пользовательский сертификат для подключаемого домена.
Примечание
Сертификаты необходимо своевременно обновлять. Подробнее о том, как обновить сертификат от Let's Encrypt® и пользовательский сертификат.
-
Дождитесь, когда сертификат перейдет в статус
Issued.
-
-
Вернитесь на страницу каталога.
-
В списке сервисов выберите API Gateway и в нем:
- Выберите API-шлюз.
- В открывшемся окне перейдите в раздел Домены.
- Нажмите Подключить, выберите сертификат и введите имя домена (FQDN).
-
Если вы пропустили шаг 1 и не разместили CNAME-запись, создайте ANAME-запись в Yandex Cloud DNS:
- В строке с доменом нажмите кнопку Создать запись.
- Если у вас нет DNS-зоны, имя которой совпадает с доменом, создайте ее. Для этого нажмите Создать зону.
- Если необходимо, в поле TTL (в секундах) выберите другое значение.
- Нажмите кнопку Создать.
Чтобы подключить домен к API-шлюзу, воспользуйтесь методом REST API addDomain для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/AddDomain.