Указать облачную сеть, в которой будет находиться API-шлюз

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

1. Посмотрите описание команды CLI для изменения API-шлюза:

   yc serverless api-gateway update --help
   

2. Получите список API-шлюзов в каталоге по умолчанию:

   yc serverless api-gateway list
   

3. Укажите облачную сеть для нужного API-шлюза:

   yc serverless api-gateway update \
     --id <идентификатор_API-шлюза> \
     --network-name <имя_облачной_сети>
   

   Где:

   • --id — идентификатор API-шлюза.
   • --network-name — имя облачной сети. Вместо имени можно указать идентификатор сети в параметре --network-id.

   Чтобы ограничить набор подсетей, в которых будет размещен API-шлюз, вместо сети укажите подсети в параметрах --subnet-id или --subnet-name.

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

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

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

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

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

1. Откройте файл конфигурации Terraform и добавьте блок connectivity в описание ресурса yandex_api_gateway:

   resource "yandex_api_gateway" "test-api-gateway" {
     name = "<имя_API-шлюза>"
     ...
     connectivity {
       network_id = "<идентификатор_облачной_сети>"
     }
   }
   

   Где network_id — идентификатор облачной сети, в которой будет находиться API-шлюз.

   Более подробную информацию о параметрах ресурса yandex_api_gateway читайте в документации провайдера.

2. Примените изменения:

   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 update для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/Update.

В параметре updateMask укажите connectivity, а в параметре connectivity.networkId — идентификатор облачной сети.