Управление эндпоинтами

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы получить список трансферов в каталоге, выполните команду:

yc datatransfer endpoint list

Воспользуйтесь методом API list.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы получить информацию об эндпоинте, выполните команду:

yc datatransfer endpoint get <идентификатор_эндпоинта>

Идентификатор эндпоинта можно получить со списком эндпоинтов в каталоге.

Воспользуйтесь методом API get и передайте значение идентификатора эндпоинта в параметре endpointId запроса.

Чтобы узнать идентификатор эндпоинта, получите список эндпоинтов в каталоге.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

   yc datatransfer endpoint create --help
   

2. Укажите параметры эндпоинта в команде создания (в примере приведены не все параметры):

   yc datatransfer endpoint create <тип_эндпоинта> \
     --name <имя_эндпоинта> \
     --description <описание_эндпоинта> \
     <параметры_эндпоинта>
   

   Тип эндпоинта и его параметры см. в разделе настроек для нужного источника или приемника данных.

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

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

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

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

1. Создайте конфигурационный файл с описанием эндпоинта.

   Пример структуры конфигурационного файла:

   resource "ycp_datatransfer_endpoint" "<имя_эндпоинта_в_Terraform>" {
     name = "<имя_эндпоинта>"
     settings {
       <тип_эндпоинта> {
         <параметры_эндпоинта>
       }
     }
   }
   

Полную схему ресурсов можно получить, запустив terraform providers schema.

1. Тип эндпоинта и его параметры см. в разделе настроек для нужного источника или приемника данных.

2. Проверьте корректность настроек.

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

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

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

3. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

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

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

4. Подробнее см. в документации провайдера Terraform.

Воспользуйтесь методом API create и передайте в запросе:

• Идентификатор каталога, в котором должен быть размещен эндпоинт, в параметре folderId.
• Имя эндпоинта в параметре name.
• Описание эндпоинта в параметре description.
• Параметры эндпоинта в параметре settings.

Параметры эндпоинта см. в разделе настроек для нужного источника или приемника данных.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы изменить настройки эндпоинта:

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

   yc datatransfer endpoint update --help
   

2. Выполните команду, передав список настроек, которые хотите изменить (в примере приведены не все параметры):

   yc datatransfer transfer update <тип_эндпоинта> <идентификатор_эндпоинта> \
     --name <имя_эндпоинта> \
     --description <описание_эндпоинта> \
     <параметры_эндпоинта>
   

   Тип эндпоинта и его параметры см. в разделе настроек для нужного источника или приемника данных. Идентификатор эндпоинта можно получить со списком эндпоинтов в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с описанием эндпоинта.

   О том, как создать такой файл, см. в подразделе Создать эндпоинт.

2. Измените значение поля name (имя эндпоинта) и параметры эндпоинта в блоке settings.

3. Проверьте корректность настроек.

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

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

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

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

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

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

Воспользуйтесь методом API update и передайте в запросе:

• Идентификатор эндпоинта в параметре endpointId
• Имя эндпоинта в параметре name.
• Описание эндпоинта в параметре description.
• Параметры эндпоинта в параметре settings.

Идентификатор эндпоинта можно получить со списком эндпоинтов в каталоге.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы удалить эндпоинт, выполните команду:

yc datatransfer endpoint delete <идентификатор_эндпоинта>

Идентификатор эндпоинта можно получить со списком эндпоинтов в каталоге.

Чтобы удалить эндпоинт, созданный с помощью Terraform:

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создать эндпоинт.

2. Убедитесь, что удаляемый эндпоинт не привязан ни к какому трансферу.

3. Удалите описание эндпоинта.

4. Проверьте корректность настроек.

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

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

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Введите слово yes и нажмите Enter.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

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

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

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

Воспользуйтесь методом API delete и передайте идентификатор нужного эндпоинта в параметре endpointId запроса.

Идентификатор эндпоинта можно получить со списком эндпоинтов в каталоге.