|
|
| Строка 1: |
Строка 1: |
| {{DISPLAYTITLE:Советник по безопасности}} | | {{DISPLAYTITLE:Советник по безопасности}} |
|
| |
| =API советника по безопасности ИИ =
| |
| ИИ Advisor Security API перечисляет рекомендации ИИ, связанные с открытыми и скрытыми проблемами безопасности .
| |
|
| |
| Вы можете ограничить вывод, используя разбиение на страницы:
| |
|
| |
| #Укажите количество результатов на странице в параметре запроса pageSize .
| |
| #Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.
| |
|
| |
| Запрос создает <code>application/json</code>полезную нагрузку.
| |
| {| class="wikitable"
| |
| |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
| |
| |}
| |
|
| |
| ==Аутентификация==
| |
| Чтобы выполнить этот запрос, вам необходимо разрешение на чтение проблем безопасности ( <code>securityProblems.read</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. [[Токены и аутентификация (API)|Токены и аутентификация]] .
| |
|
| |
| ==Параметры==
| |
| {| class="wikitable"
| |
| !Параметр
| |
| !Тип
| |
| !Описание
| |
| !In
| |
| !необходимость
| |
| |-
| |
| |managementZoneFilter
| |
| |string
| |
| |Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.
| |
|
| |
| *Идентификатор зоны управления: ids («mzId-1», «mzId-2»).
| |
| *Названия зон управления: наименования («МЗ-1», «МЗ-2»).
| |
|
| |
| Вы можете указать несколько критериев, разделенных запятыми (например, <code>names("myMz"),ids("9130632296508575249")</code>).
| |
| |запрос
| |
| |по желанию
| |
| |-
| |
| |nextPageKey
| |
| |string
| |
| |Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
| |
|
| |
| Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .
| |
|
| |
| Если nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
| |
| |запрос
| |
| |по желанию
| |
| |-
| |
| |размер страницы
| |
| |integer
| |
| |Количество советов по безопасности в одной полезной нагрузке.
| |
|
| |
| Максимально допустимый размер страницы - 500.
| |
|
| |
| Если не установлен, используется 5.
| |
| | запрос
| |
| |по желанию
| |
| |}
| |
|
| |
| ==Ответ==
| |
|
| |
| ===Коды ответов===
| |
| {| class="wikitable"
| |
| !Код
| |
| !Описание
| |
| |-
| |
| |200
| |
| |Успех
| |
| |}
| |
|
| |
| ===Тело ответа===
| |
|
| |
| *Параметры ответа
| |
|
| |
| ====AISecurityAdviceList объект====
| |
| Список советов от советника по безопасности ИИ.
| |
| {| class="wikitable"
| |
| !Элемент
| |
| !Тип
| |
| !Описание
| |
| |-
| |
| |totalCount
| |
| |integer
| |
| |Общее количество записей в результате.
| |
| |-
| |
| |размер страницы
| |
| |integer
| |
| |Количество записей на странице.
| |
| |-
| |
| |nextPageKey
| |
| |string
| |
| |Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
| |
|
| |
| Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
| |
|
| |
| Может быть <code>null</code>.
| |
| |-
| |
| |advices
| |
| |AISecurityAdvice[]
| |
| | -
| |
| Может быть <code>null</code>.
| |
| |}
| |
|
| |
| ====AISecurityAdvice объект====
| |
| Совет по безопасности от советника по безопасности Дэвиса.
| |
| {| class="wikitable"
| |
| !Элемент
| |
| !Тип
| |
| !Описание
| |
| |-
| |
| |name
| |
| |string
| |
| |Название совета.
| |
| |-
| |
| |vulnerableComponent
| |
| |string
| |
| |Уязвимый компонент, к которому применяется совет.
| |
| |-
| |
| |technology
| |
| |string
| |
| |Технология уязвимого компонента.
| |
|
| |
| Элемент может содержать эти значения
| |
| |-
| |
| |adviceType
| |
| |string
| |
| |Тип совета.
| |
|
| |
| Элемент может содержать эти значения
| |
| |-
| |
| |critical
| |
| |string[]
| |
| |Идентификаторы проблем <code>critical</code>уровня безопасности, вызванных уязвимым компонентом.
| |
| |-
| |
| |high
| |
| |string[]
| |
| |Идентификаторы проблем <code>high</code>уровня безопасности, вызванных уязвимым компонентом.
| |
| |-
| |
| |medium
| |
| |string[]
| |
| |Идентификаторы проблем <code>medium</code>уровня безопасности, вызванных уязвимым компонентом.
| |
| |-
| |
| |low
| |
| |string[]
| |
| |Идентификаторы проблем <code>low</code>уровня безопасности, вызванных уязвимым компонентом.
| |
| |-
| |
| |now
| |
| |string[]
| |
| |Идентификаторы проблем <code>none</code>уровня безопасности, вызванных уязвимым компонентом.
| |
| |}
| |
|
| |
| *Модель JSON
| |
|
| |
| ===Тело ответа===
| |
| <code>{
| |
| "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"
| |
| ]
| |
| }
| |
| ]
| |
| }</code>
| |
| * | | * |
