Подключить домен

Статья создана

Улучшена

Обновлена 15 октября 2026 г.

Вы можете подключить собственный домен для обращения к 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.

На домене должен быть установлен X.509‑сертификат, соответствующий требованиям IETF (RFC 2459/3280/5280). Для сертификатов с алгоритмом ECDSA поддерживается только кривая P‑256.

Чтобы подключить домен к API-шлюзу:

Консоль управления

Terraform

API

Разместите у своего DNS-провайдера или на собственном DNS-сервере CNAME-запись:
```
<домен> IN CNAME <служебный_домен_API-шлюза>
```
Чтобы узнать служебный домен API-шлюза:
1. Перейдите в консоль управления и выберите каталог, в котором находится API-шлюз.
2. Перейдите в сервис API Gateway.
3. Выберите API-шлюз.
4. Служебный домен будет в поле Служебный домен.
Доменные имена должны заканчиваться точкой.

Чтобы использовать домен выше второго уровня, делегируйте его Yandex Cloud DNS и создайте ANAME-запись в зоне DNS. Создать запись в Yandex Cloud DNS можно не только до, но и после создания домена. Смотрите шаг 6.
В консоли управления выберите каталог, в котором находится API-шлюз.
Перейдите в сервис Certificate Manager и в нем:
1. Добавьте сертификат от Let's Encrypt^® или пользовательский сертификат для подключаемого домена.
  
  Примечание
  
  Сертификаты необходимо своевременно обновлять. Подробнее о том, как обновить сертификат от Let's Encrypt^® и пользовательский сертификат.
2. Дождитесь, когда сертификат перейдет в статус Issued.
Вернитесь на страницу каталога.
Перейдите в сервис API Gateway и в нем:
1. Выберите API-шлюз.
2. Перейдите на вкладку Домены.
3. Нажмите Подключить, выберите сертификат и введите имя домена (FQDN).
Если вы пропустили шаг 1 и не разместили CNAME-запись, создайте ANAME-запись в Yandex Cloud DNS:
1. В строке с доменом нажмите кнопку Создать запись.
2. Если у вас нет DNS-зоны, имя которой совпадает с доменом, создайте ее. Для этого нажмите Создать зону.
3. Если необходимо, в поле TTL (в секундах) выберите другое значение.
4. Нажмите кнопку Создать.

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробная информация о ресурсах провайдера в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

Чтобы управлять инфраструктурой с помощью Terraform от имени сервисного аккаунта или пользовательских аккаунтов: аккаунта на Яндексе, федеративного аккаунта и локального пользователя, аутентифицируйтесь соответствующим способом.

Откройте файл конфигурации Terraform и добавьте блок custom_domains в описание ресурса yandex_api_gateway:
```
resource "yandex_api_gateway" "<имя_API-шлюза>" {
  name = "<имя_API-шлюза>"
  ...
  custom_domains {
    fqdn           = "<доменное_имя>"
    certificate_id = "<идентификатор_сертификата>"
  }
}
```
Где:
- fqdn — FQDN подключаемого домена.
- certificate_id — идентификатор сертификата домена в Yandex Certificate Manager.
Более подробную информацию о параметрах ресурса yandex_api_gateway читайте в документации провайдера.
Примените изменения:
1. В терминале перейдите в директорию с конфигурационным файлом.
2. Проверьте корректность конфигурации с помощью команды:
```
terraform validate
```
  Если конфигурация является корректной, появится сообщение:
```
Success! The configuration is valid.
```
3. Выполните команду:
```
terraform plan
```
  В терминале будет выведен список планируемых изменений: ресурсы и/или выходные переменные. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.
4. Примените изменения конфигурации:
```
terraform apply
```
5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.
Проверить результат можно в консоли управления или с помощью команды CLI:
```
yc serverless api-gateway get <идентификатор_API-шлюза>
```

Чтобы подключить домен к API-шлюзу, воспользуйтесь методом REST API addDomain для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/AddDomain.

Подключить домен

Была ли статья полезна?