REST Resource: alerts

Ресурс: Оповещение

Предупреждение, затрагивающее клиента.

Представление JSON
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
Поля
customerId

string

Только вывод. Уникальный идентификатор аккаунта Google Workspace клиента.

alertId

string

Только вывод. Уникальный идентификатор оповещения.

createTime

string ( Timestamp format)

Только вывод. Время создания этого оповещения.

startTime

string ( Timestamp format)

Необходимый. Время, когда событие, вызвавшее это предупреждение, было запущено или обнаружено.

endTime

string ( Timestamp format)

Необязательный. Время, когда событие, вызвавшее это оповещение, перестало быть активным. Если указано, время окончания не должно быть раньше времени начала. Если не указано, это указывает на текущее оповещение.

type

string

Необходимый. Тип оповещения. Это выводится только после создания предупреждения. Список доступных типов предупреждений см. в разделе Типы предупреждений Google Workspace .

source

string

Необходимый. Уникальный идентификатор системы, которая сообщила об оповещении. Это выводится только после создания предупреждения.

Поддерживаются следующие источники:

  • Google Операции
  • Управление мобильными устройствами
  • фишинг в Gmail
  • Предотвращение потери данных
  • Вынос на весь домен
  • Атака, спонсируемая государством
  • Личность Google
  • Сбой приложений
data

object

Необязательный. Данные, связанные с этим оповещением, например google.apps.alertcenter.type.DeviceCompromised .

deleted

boolean

Только вывод. True , если это оповещение помечено для удаления.

metadata

object ( AlertMetadata )

Только вывод. Метаданные, связанные с этим оповещением.

updateTime

string ( Timestamp format)

Только вывод. Время последнего обновления этого оповещения.

etag

string

Необязательный. etag используется для управления оптимистичным параллелизмом, чтобы предотвратить перезапись одновременных обновлений предупреждений друг другом. Настоятельно рекомендуется, чтобы системы использовали etag в цикле чтения-изменения-записи для выполнения обновлений предупреждений, чтобы избежать условий гонки: etag возвращается в ответе, содержащем предупреждения, и ожидается, что системы поместят этот etag в запрос на обновление оповещения, чтобы гарантировать, что их изменение будет применено к той же версии оповещения.

Если в вызове для обновления оповещения не etag , существующее оповещение перезаписывается вслепую.

ОповещениеМетаданные

Метаданные предупреждения.

Представление JSON
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Поля
customerId

string

Только вывод. Уникальный идентификатор аккаунта Google Workspace клиента.

alertId

string

Только вывод. Идентификатор оповещения.

status

string

Текущий статус оповещения. Поддерживаются следующие значения:

  • НЕ НАЧАТО
  • В ХОДЕ ВЫПОЛНЕНИЯ
  • ЗАКРЫТО
assignee

string

Адрес электронной почты пользователя, назначенного оповещению.

updateTime

string ( Timestamp format)

Только вывод. Время последнего обновления этих метаданных.

severity

string

Значение серьезности предупреждения. Центр предупреждений установит это поле во время создания предупреждения, по умолчанию используется пустая строка, если ее невозможно определить. Поддерживаемые значения для действий обновления в этом поле:

  • ВЫСОКИЙ
  • СРЕДНЯЯ
  • НИЗКИЙ
etag

string

Необязательный. etag используется для управления оптимистичным параллелизмом, чтобы предотвратить перезапись одновременных обновлений метаданных предупреждений друг другом. Настоятельно рекомендуется, чтобы системы использовали etag в цикле чтения-изменения-записи для выполнения обновлений метаданных, чтобы избежать условий гонки: etag возвращается в ответе, который содержит метаданные предупреждения, и ожидается, что системы поместят этот etag в запросе на обновление метаданных предупреждения, чтобы гарантировать, что их изменение будет применено к той же версии метаданных предупреждения.

Если в вызове для обновления метаданных предупреждений не etag , существующие метаданные предупреждений перезаписываются вслепую.

Методы

batchDelete

 Выполняет операцию пакетного удаления предупреждений.

batchUndelete

 Выполняет пакетную операцию восстановления предупреждений.

delete

 Отмечает указанное оповещение для удаления.

get

 Получает указанное предупреждение.

getMetadata

 Возвращает метаданные оповещения.

list

 Список предупреждений.

undelete

 Восстанавливает или «восстанавливает» оповещение, которое было помечено для удаления в течение последних 30 дней.