API Gateway

Группы API

Создание группы

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
Нажмите Create API Group.
Заполните следующие поля и нажмите ОК:
1. Name — укажите имя группы.
2. Description — введите описание.
В новом окне нажмите ОК.

Прикрепление доменного имени к группе

Прежде чем опубликовать API, к принадлежащей ему группе нужно прикрепить один или несколько внешних доменов (до 5). Если доменные имена не привязаны к группе, то API будет вызываться с использованием имени поддомена и количество вызовов будет ограничено 1000 в день.

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
В строке с нужной группой нажмите More и выберите из списка Manage Domain Name.
Нажмите Bind Domain Name.

Внимание
В доменном имени должна быть CNAME-запись с именем поддомена группы API (скопируйте имя в API Group → вкладка Summary > скопируйте имя в поле Subdomain Name).
Введите в поле доменное имя в формате www.example.com и нажмите значок .
После успешного добавления доменного имени появится новая запись.

Прикрепление SSL сертификата

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
В строке с нужной группой нажмите More и выберите из списка Manage Domain Name.
В строке с нужным доменом нажмите Add SSL Certificate.
Заполните поля и нажмите ОК:
1. Certificate Name — укажите имя сертификата.
2. Certificate Content — введите запрос (публичный ключ) вашего сертификата.
3. Private Key — введите приватный ключ вашего сертификата.

Ответ шлюза

Добавление ответа шлюза

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
Нажмите на имя нужной группы.
Перейдите на вкладку Gateway Responses и нажмите Create Gateway Response.
В поле Name укажите имя отклика и нажмите ОК.
Сделайте следующее:
1. Нажмите на имя нового отклика.
2. Выберите в списке нужный тип отклика.
3. Нажмите Edit.
4. Укажите нужный код ответа (поле Status Code) и введите в редактор сообщение об ошибке.
5. После произведенных изменений нажмите ОК (появляется в режиме редактирования отклика).

Изменение ответа шлюза

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
Нажмите на имя нужной группы.
Перейдите на вкладку Gateway Responses, выберите нужный отклик и тип отклика. Нажмите Edit.
Сделайте следующее и нажмите ОК:
1. В поле Status Code укажите нужный код ответа.
2. Введите в редактор сообщение об ошибке.

Удаление ответа шлюза

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
Нажмите на имя нужной группы.
Перейдите на вкладку Gateway Responses, наведите курсор на строку нужного отклика, нажмите на значок и выберите из списка Delete.
Нажмите ОК.

Удаление группы

В списке сервисов выберите API Gateway.
Далее выберите API Publishing → API Groups.
В строке с нужной группой нажмите More и выберите из списка Delete.
Введите в поле слово «DELETE» и нажмите Yes.

Примечание

Удалить можно только группу, к которой не привязан API. Сначала удалите API, затем — группу.

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

Поддержка Юридические документы