組織またはソースの検出結果をフィルタし、指定したプロパティでグループ化します。
すべてのソースにまたがってグループ化するには、ソース ID として -
を指定します。例: /v1/organizations/{organization_id}/sources/-/findings、/v1/folders/{folder_id}/sources/-/findings、/v1/projects/{projectId}/sources/-/findings
HTTP リクエスト
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。groupBy のソースの名前。形式は「organizations/[organization_id]/sources/[source_id]」、「folders/[folder_id]/sources/[source_id]」、「projects/[projectId]/sources/[source_id]」です。すべてのソースでグループ化するには、source_id に |
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "filter": string, "groupBy": string, "readTime": string, "compareDuration": string, "pageToken": string, "pageSize": integer } |
フィールド | |
---|---|
filter |
検出結果全体に適用するフィルタを定義する式。式は、論理演算子 制限は
サポートされている演算子は次のとおりです。
サポートされている値の型は次のとおりです。
次のフィールドと演算子の組み合わせがサポートされています。
使用方法: エポックからのミリ秒数または RFC3339 文字列にする必要があります。例:
たとえば、 空の文字列の部分一致を使用して、既存のプロパティ( 空の文字列に対する否定的な部分一致を使用して、存在しないプロパティに基づいてフィルタします。 |
groupBy |
必須。グループ化に使用するアセット フィールド( 次のフィールドがサポートされています。
compareDuration が設定されている場合、次のフィールドがサポートされます。
|
readTime |
検出結果のフィルタリング時に参照点として使用される時間。フィルタは、指定された時刻に存在する検出結果に限定され、その値は特定の時刻の値になります。このフィールドが指定されていない場合、デフォルトは API のバージョンの NOW になります。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
compareDuration |
compareDuration が設定されている場合、GroupResult の「stateChange」属性が更新され、検出結果の状態が変更されたかどうか、検出結果の状態が変更されていないかどうか、または readTime より前の compareDuration 期間中に検出結果が追加されたかどうかが示されます。これは、(readTime - compareDuration)と readTime の間の時間です。 stateChange 値は、2 つの時点での検出結果の存在と状態に基づいて導出されます。2 回目の測定までの間の中間状態の変化は結果に影響しません。たとえば、検出結果を無効にしてから再度有効にしても、結果は影響を受けません。 compareDuration が指定されている場合の「stateChange」の有効な値:
compareDuration が指定されていない場合、使用可能な stateChange は「UNUSED」のみです。これは、readTime に存在するすべての検出結果に設定される stateChange です。 このフィールドが設定されている場合、
|
pageToken |
最後の |
pageSize |
1 回のレスポンスで返される結果の最大件数。デフォルトは 10 で、最小値は 1、最大値は 1,000 です。 |
レスポンスの本文
成功した場合、レスポンスの本文には GroupFindingsResponse
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/cloud-platform
詳細については、Authentication Overview をご覧ください。