Добавить метку API-шлюзу

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

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

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

yc serverless api-gateway update <имя_API-шлюза> \
  --labels <ключ>=<значение>[,<ключ>=<значение>]

Результат:

id: d5de8465hjvo********
folder_id: b1g681qpemb4********
created_at: "2024-11-26T20:16:50.785Z"
name: my-gateway
labels:
  test: test
  version: beta
status: ACTIVE
domain: d5dm1lba80md********.i9******.apigw.yandexcloud.net
connectivity: {}
log_options:
  folder_id: b1g681qpemb4********
execution_timeout: 300s

Вы можете указать несколько пар <ключ>=<значение> через запятую.

Убедиться, что метки API-шлюза изменились, можно в консоли управления или с помощью команды CLI:

yc serverless api-gateway get <имя_API-шлюза>

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

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

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

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

Чтобы добавить метку API-шлюзу:

1. В конфигурационном файле Terraform добавьте блок labels и перечислите в нем список меток в формате <ключ>:"<значение>".

   Пример описания API-шлюза в конфигурации Terraform:

   resource "yandex_api_gateway" "test-api-gateway" {
     name        = "my-gateway"
     description = "any description"
     labels      = {
       label       = "label"
       empty-label = ""
     }
     spec = <<-EOT
       openapi: 3.0.0
       info:
         title: Sample API
         version: 1.0.0
       paths:
         /:
           get:
             x-yc-apigateway-integration:
               type: dummy
               content:
                 '*': Hello, World!
               http_code: 200
               http_headers:
                 Content-Type: text/plain
     EOT
   }
   

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

2. Создайте ресурсы:

   1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

   2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate
      

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.
      

   3. Выполните команду:

      terraform plan
      

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

   4. Примените изменения конфигурации:

      terraform apply
      

   5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

Убедиться, что метки API-шлюза изменились, можно в консоли управления или с помощью команды CLI:

yc serverless api-gateway get <имя_API-шлюза>

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