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 Operations
  • モバイル デバイスの管理
  • Gmail のフィッシング
  • データ損失防止（DLP）
  • ドメイン全体のデータ エクスポート
  • 国家主導型サイバー攻撃
  • Google の ID
  • アプリの停止
data

object

省略可。このアラートに関連付けられたデータ（google.apps.alertcenter.type.DeviceCompromised など）。
deleted

boolean

出力専用。True: このアラートが削除対象としてマークされている場合。
metadata

object (AlertMetadata)

出力専用。このアラートに関連付けられたメタデータ。
updateTime

string (Timestamp format)

出力専用。このアラートが最後に更新された日時。
etag

string

省略可。etag は、アラートの同時更新による相互上書きを防ぐ方法として、オプティミスティック同時実行制御で使用されます。競合状態を回避するために、システムが読み取り / 変更 / 書き込みサイクルで etag を使用して、アラートの更新を行うことを強くおすすめします。アラートが含まれるレスポンスで etag が返されます。システムは、変更が同じバージョンのアラートに適用されるように、その etag をリクエストにアラート更新に含める必要があります。

アラートの更新呼び出しに etag が指定されていない場合、既存のアラートは盲目的に上書きされます。

AlertMetadata

アラート メタデータ。

JSON 表現 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
フィールド
customerId

string

出力専用。お客様の Google Workspace アカウントの一意の識別子。
alertId

string

出力専用。アラート ID。
status

string

アラートの現在のステータス。サポートされている値は次のとおりです。

  • NOT_STARTED
  • IN_PROGRESS
  • 終了
assignee

string

アラートに割り当てられたユーザーのメールアドレス。
updateTime

string (Timestamp format)

出力専用。このメタデータが最後に更新された時刻。
severity

string

アラートの重大度の値。このフィールドは、アラートの作成時にアラート センターによって設定されます。特定できない場合は、デフォルトで空の文字列になります。このフィールドの更新アクションでサポートされている値は次のとおりです。

  • 高
  • MEDIUM
  • 低
etag

string

省略可。etag は、アラート メタデータの同時更新による相互上書きを防ぐ方法として、オプティミスティック同時実行制御で使用されます。競合状態を回避するために、システムが読み取り / 変更 / 書き込みサイクルで etag を使用して、メタデータの更新を行うことを強くおすすめします。etag は、アラート メタデータを含むレスポンスで返されます。システムは、その etag をリクエストに含めてアラート メタデータを更新し、変更が同じバージョンのアラート メタデータに適用されるようにする必要があります。

アラート メタデータを更新する呼び出しに etag が指定されていない場合、既存のアラート メタデータが盲目的に上書きされます。

メソッド

batchDelete

 アラートで一括削除オペレーションを実行します。

batchUndelete

 アラートの一括削除の取り消し操作を行います。

delete

 指定したアラートを削除対象としてマークします。

get

 指定したアラートを取得します。

getMetadata

 アラートのメタデータを返します。

list

 アラートを一覧表示します。

undelete

 過去 30 日以内に削除対象としてマークされたアラートを復元します（「削除を取り消す」）。