Советник по безопасности1: различия между версиями

Материал из Документация Ключ-АСТРОМ
Строка 1: Строка 1:
{{DISPLAYTITLE:Советник по безопасности ИИ}}
{{DISPLAYTITLE:Советник по безопасности}}


= API советника по безопасности ИИ =
=API советника по безопасности ИИ =
ИИ Advisor Security API перечисляет рекомендации ИИ, связанные с открытыми и скрытыми проблемами безопасности .
ИИ Advisor Security API перечисляет рекомендации ИИ, связанные с открытыми и скрытыми проблемами безопасности .


Вы можете ограничить вывод, используя разбиение на страницы:
Вы можете ограничить вывод, используя разбиение на страницы:


# Укажите количество результатов на странице в параметре запроса pageSize .
#Укажите количество результатов на странице в параметре запроса pageSize .
# Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.
#Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Строка 13: Строка 13:
|GET
|GET
|
|
* Managed https: // {vash-domen} / e / {your-environment-id} / api / v2 / AI / securityAdvices
*Managed https: // {vash-domen} / e / {your-environment-id} / api / v2 / AI / securityAdvices
* Environment АктивныйШлюз https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / AI / securityAdvices
*Environment АктивныйШлюз https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / AI / securityAdvices
|}
|}


== Аутентификация ==
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение проблем безопасности ( <code>securityProblems.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. [[Токены и аутентификация (API)|Токены и аутентификация]] .
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение проблем безопасности ( <code>securityProblems.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
==Параметры==
{| class="wikitable"
{| class="wikitable"
!Параметр
!Параметр
Строка 32: Строка 32:
|Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.
|Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.


* Идентификатор зоны управления: ids («mzId-1», «mzId-2»).
*Идентификатор зоны управления: ids («mzId-1», «mzId-2»).
* Названия зон управления: наименования («МЗ-1», «МЗ-2»).
*Названия зон управления: наименования («МЗ-1», «МЗ-2»).


Вы можете указать несколько критериев, разделенных запятыми (например, <code>names("myMz"),ids("9130632296508575249")</code>).
Вы можете указать несколько критериев, разделенных запятыми (например, <code>names("myMz"),ids("9130632296508575249")</code>).
Строка 56: Строка 56:


Если не установлен, используется 5.
Если не установлен, используется 5.
|запрос
| запрос
|по желанию
|по желанию
|}
|}


== Ответ ==
==Ответ==


=== Коды ответов ===
===Коды ответов===
{| class="wikitable"
{| class="wikitable"
!Код
!Код
Строка 71: Строка 71:
|}
|}


=== Тело ответа ===
===Тело ответа===


* Параметры ответа
*Параметры ответа


==== AISecurityAdviceList объект ====
====AISecurityAdviceList объект====
Список советов от советника по безопасности Дэвиса.
Список советов от советника по безопасности Дэвиса.
{| class="wikitable"
{| class="wikitable"
Строка 104: Строка 104:
|}
|}


==== AISecurityAdvice объект ====
====AISecurityAdvice объект====
Совет по безопасности от советника по безопасности Дэвиса.
Совет по безопасности от советника по безопасности Дэвиса.
{| class="wikitable"
{| class="wikitable"
Строка 152: Строка 152:
|}
|}


* Модель JSON
*Модель JSON


=== Тело ответа ===
===Тело ответа===
  <code>{
  <code>{
   "totalCount": 1,
   "totalCount": 1,

Версия 10:36, 7 июля 2023


API советника по безопасности ИИ

ИИ Advisor Security API перечисляет рекомендации ИИ, связанные с открытыми и скрытыми проблемами безопасности .

Вы можете ограничить вывод, используя разбиение на страницы:

  1. Укажите количество результатов на странице в параметре запроса pageSize .
  2. Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.

Запрос создает application/jsonполезную нагрузку.

GET
  • Managed https: // {vash-domen} / e / {your-environment-id} / api / v2 / AI / securityAdvices
  • Environment АктивныйШлюз https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / AI / securityAdvices

Аутентификация

Чтобы выполнить этот запрос, вам необходимо разрешение на чтение проблем безопасности ( securityProblems.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

Параметры

Параметр Тип Описание In необходимость
managementZoneFilter string Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.
  • Идентификатор зоны управления: ids («mzId-1», «mzId-2»).
  • Названия зон управления: наименования («МЗ-1», «МЗ-2»).

Вы можете указать несколько критериев, разделенных запятыми (например, names("myMz"),ids("9130632296508575249")).

запрос по желанию
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Если nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

запрос по желанию
размер страницы integer Количество советов по безопасности в одной полезной нагрузке.

Максимально допустимый размер страницы - 500.

Если не установлен, используется 5.

запрос по желанию

Ответ

Коды ответов

Код Описание
200 Успех

Тело ответа

  • Параметры ответа

AISecurityAdviceList объект

Список советов от советника по безопасности Дэвиса.

Элемент Тип Описание
totalCount integer Общее количество записей в результате.
размер страницы integer Количество записей на странице.
nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть null.

advices AISecurityAdvice[] -

Может быть null.

AISecurityAdvice объект

Совет по безопасности от советника по безопасности Дэвиса.

Элемент Тип Описание
name string Название совета.
vulnerableComponent string Уязвимый компонент, к которому применяется совет.
technology string Технология уязвимого компонента.

Элемент может содержать эти значения

adviceType string Тип совета.

Элемент может содержать эти значения

critical string[] Идентификаторы проблем criticalуровня безопасности, вызванных уязвимым компонентом.
high string[] Идентификаторы проблем highуровня безопасности, вызванных уязвимым компонентом.
medium string[] Идентификаторы проблем mediumуровня безопасности, вызванных уязвимым компонентом.
low string[] Идентификаторы проблем lowуровня безопасности, вызванных уязвимым компонентом.
now string[] Идентификаторы проблем noneуровня безопасности, вызванных уязвимым компонентом.
  • Модель JSON

Тело ответа

{
  "totalCount": 1,
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "advices": [
    {
      "name": "string",
      "vulnerableComponent": "string",
      "technology": "DOTNET",
      "adviceType": "UPGRADE",
      "critical": [
        "string"
      ],
      "high": [
        "string"
      ],
      "medium": [
        "string"
      ],
      "low": [
        "string"
      ],
      "none": [
        "string"
      ]
    }
  ]
}
Источник — https://doc.ruscomtech.ru/index.php?title=Советник_по_безопасности1&oldid=2948