Создание API

Чтобы настроить скачивание файла из OBS с помощью API, создайте API-группу и API по инструкциям ниже.

Создание API Group

API объединяются в API-группы. Каждый API может принадлежать только одной группе. Все API из одной группы доступны по одному доменному имени. Чтобы создать API Group:

  1. В списке сервисов выберите API Gateway.

  2. Перейдите в раздел API Publishing → API Groups.

  3. Нажмите Create API Group.

  4. В поле Name укажите название API-группы.

  5. Нажмите ОК.

API-группа создана.

Внимание

К каждой API-группе присваивается стандартный поддомен. Количество обращений к API по стандартному поддомену ограничено. Ограничение составляет 1 000 запросов в сутки. Чтобы снять это ограничение, привяжите доменное имя к группе API.

Создание API

  1. Перейдите в раздел API Publishing → APIs.

  2. Нажмите Create API.

  3. В поле Name укажите название публикуемого API.

  4. В поле API Group выберите созданную ранее группу.

  5. В поле Security Authentication выберите None. При выборе этого варианта вызовы API будут доступны без аутентификации.

  6. Нажмите Next.

  7. В поле Path введите путь, по которому будет публиковаться API. Например /Get.

    Примечание

    Значение в поле Path чувствительно к регистру. /get и /Get — разные пути.

  8. В поле Method выберите Get.

  9. Нажмите Next.

  10. В поле Backend Type выберите HTTP/HTTPS.

  11. В поле Protocol выберите HTTPS.

  12. В поле Method выберите GET.

  13. Скопируйте ссылку на загруженный ранее объект в OBS по инструкции.

  14. В поле Backend Address вставьте адрес объекта в OBS без https:// и без части, которая идет после символа /. Например, если адрес объекта — https://bucket-name.obs.ru-moscow-1.hc.sbercloud.ru/file.zip, то нужно вставить bucket-name.obs.ru-moscow-1.hc.sbercloud.ru.

  15. В поле Path вставьте часть, которая идет после символа /, включая сам символ. Например, если адрес объекта — https://bucket-name.obs.ru-moscow-1.hc.sbercloud.ru/file.zip, то нужно вставить /file.zip.

  16. Нажмите Next → Finish → Publish API → Publish.

API опубликован. Перейдите к его проверке.

Проверка работы API

Чтобы протестировать работу API, перейдите по ссылке, по которой API опубликован. Для этого:

  1. Перейдите в раздел API Publishing → APIs.

  2. Нажмите на название созданного API.

  3. Скопируйте адрес из поля API URL.

  4. Вставьте URL в адресную строку и перейдите по нему. Файл из OBS будет загружен после перехода по ссылке.

API создан и настроен.