REST Resource: alerts

リソース: Alert

顧客に影響するアラート。

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 日間に削除のマークが付けられたアラートを復元、または「削除取り消し」します。