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

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

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

string

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

updateTime

string ( Timestamp format)

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

severity

string

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

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

string

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

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

Методы

batchDelete

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

batchUndelete

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

delete

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

get

 Получает указанное оповещение.

getMetadata

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

list

 Перечисляет оповещения.

undelete

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