API-токены
Запись таблицы API-токены (mai_api_token) – это ключ, по которому потребитель обращается к нексусам. Токен выдается для конкретной инсталляции клиента, а его значение хранится в экземпляре хранилища токенов.
Через запись токена вы можете ограничить квоту, заблокировать доступ потребителя к нексусам и полностью отозвать ключ.
Те же операции выполняются запросами к инсталляции. Читайте подробнее в статье Выпуск токенов через API.
Требуемые роли:
- Чтение – mai_reporter.
- Создание – mai_admin.
- Обновление – mai_admin.
- Удаление записи не предусмотрено: вместо удаления токен отзывается действием Удалить.
Просмотр и создание токена
- Перейдите в навигаторе в Управление инсталляциями приложений (MAI) → Инфраструктура Ainergy → API-токены.
- Откройте нужную запись из списка или нажмите Создать и заполните поля формы.
- Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.
Запись токена создается только после подтверждения от хранилища токенов. Если хранилище не ответило или вернуло ошибку, запись в системе не создается, а на форме отображается причина отказа. Это исключает ситуацию, когда в панели управления есть активный токен, которого нет в хранилище.
Поля формы API-токены
| Поле | Обязательно | Описание |
|---|---|---|
| Инсталляция | Да | Укажите инсталляцию клиента, для которой выдается токен. |
| Роль | Да | Выберите роль, с которой токен обращается к нексусам. Доступные опции:
|
| Экземпляр хранилища токенов | Да | Укажите экземпляр хранилища токенов, в котором будет храниться значение токена. |
| Пользователь | Нет | Укажите пользователя, которому принадлежит токен. |
| Да | Укажите адрес электронной почты, связанный с токеном. | |
| ID токена | Нет | Идентификатор токена в хранилище токенов. Поле заполняется автоматически. |
| Статус | Нет | Текущее состояние токена. Значение меняется действиями на форме и автоматически при исчерпании квоты. Возможные опции:
|
| Истекает | Нет | Укажите дату и время истечения срока действия токена. |
| Квота (А-токен) | Нет | Укажите квоту А-токенов для этого ключа. При исчерпании квоты токен блокируется автоматически, и устанавливается флажок Заблокирован по квоте. Квоту можно изменить, пока токен не отозван и не является мастер-токеном. Блокировка изменению квоты не мешает, поэтому квоту можно увеличить, чтобы разблокировать токен, заблокированный по квоте. |
| Заблокирован по квоте | Нет | Флажок установлен, если токен заблокирован автоматически из-за исчерпания квоты. |
| Заблокирован администратором MW | Нет | Флажок установлен, если токен заблокирован администратором инфраструктуры. |
| Заблокирован администратором | Нет | Флажок установлен, если токен заблокирован администратором платформы. Снять этот признак вручную нельзя. |
| Причина блокировки (администратор MW) | Нет | Причина блокировки, указанная администратором инфраструктуры. |
| Причина блокировки (администратор) | Нет | Причина блокировки, указанная администратором платформы. |
Если токен является мастер-токеном инсталляции, над полями формы отображается метка Master token. Квота мастер-токена не редактируется.
Изменения состояния токена и указанные причины блокировки фиксируются в Ленте активности справа. Используйте фильтры История и Пр ичина, чтобы посмотреть, кто и когда менял состояние токена.
Действия API-токены
Все действия расположены на панели в верхней части формы.
| UI-действие | Описание |
|---|---|
| Заблокировать токен | Нажмите, чтобы заблокировать токен. Действие доступно, пока токен не отозван и не заблокирован администратором инфраструктуры. |
| Разблокировать токен | Нажмите, чтобы разблокировать токен. Действие доступно, если токен заблокирован администратором инфраструктуры и при этом не заблокирован по квоте. |
| Удалить | Нажмите, чтобы отозвать токен. Действие доступно, пока токен не отозван. |
| Копировать токен | Нажмите, чтобы скопировать значение токена для передачи потребителю. Действие доступно пользователю с ролью mai_admin, если токен не отозван. |
| Показать данные подключения LLM | Нажмите, чтобы посмотреть параметры подключения к нексусам с этим токеном. |
Блокировка и разблокировка токена
Токен блокируется тремя способами, и они независимы друг от друга:
- Автоматически по квоте – при исчерпании значения поля Квота (А-токен). Устанавливается флажок Заблокирован по квоте.
- Администратором инфраструктуры – действием Заблокировать токен. Устанавливается флажок Заблокирован администратором MW, причина попадает в поле Причина блокировки (администратор MW).
- Администратором платформы – устанавливается флажок Заблокирован администратором и заполняется поле Причина блокировки (администратор). Вручную снять эту блокировку нельзя.
Токен возвращается в состояние Активен только тогда, когда сняты все блокир овки. Поэтому токен, заблокированный и по квоте, и администратором инфраструктуры, действием Разблокировать токен не разблокируется – сначала нужно увеличить квоту.
Блокировка, разблокировка и отзыв токена выполняются не только кнопками: тот же результат дает изменение поля Статус или признаков блокировки прямо в записи. В любом случае изменение сначала отправляется в хранилище токенов и сохраняется только при успешном ответе. Если хранилище недоступно или отклонило запрос, изменение не сохраняется, а на форме отображается причина отказа.
Отзыв токена
Чтобы отозвать токен, нажмите Удалить на панели в верхней части формы. Токен переходит в состояние Удален, и запросы по нему больше не проходят.
Отзыв токена необратим: вернуть запись в состояние Активен нельзя, квота отозванного токена не редактируется. Чтобы выдать потребителю доступ заново, создайте новую запись токена.