Method: organizations.sources.findings.group

組織またはソースの検出結果をフィルタし、指定したプロパティでグループ化します。

すべてのソースにまたがってグループ化するには、ソース ID として - を指定します。例: /v1beta1/organizations/{organization_id}/sources/-/findings

HTTP リクエスト


この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。groupBy のソースの名前。形式は「organizations/[organization_id]/sources/[source_id]」です。すべてのソースでグループ化するには、source_id に - を指定します。例: organizations/{organization_id}/sources/-

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "filter": string,
  "groupBy": string,
  "readTime": string,
  "pageToken": string,
  "pageSize": integer
}
フィールド
filter

string

検出結果全体に適用するフィルタを定義する式。式は、論理演算子 AND と OR で結合された 1 つ以上の制限のリストです。かっこはサポートされていません。また、OR は AND よりも優先度が高くなります。

制限は <field> <operator> <value> の形式で、否定を示すために前に - 文字を付けることができます。次に例を示します。

  • name
  • sourceProperties.a_property
  • securityMarks.marks.marka

サポートされている演算子は次のとおりです。

  • すべての値型で =。
  • 整数値の場合は >、<、>=、<=。
  • :: 文字列の部分文字列照合。

サポートされている値の型は次のとおりです。

  • 文字列リテラルは引用符で囲みます。
  • 整数リテラル（引用符なし）。
  • ブール値リテラル true と false（引用符なし）。

たとえば、sourceProperties.size = 100 は有効なフィルタ文字列です。
groupBy

string

必須。グループ化に使用するアセット フィールド（state を含む）を定義する式。文字列の値は、SQL 構文に従って、フィールドのカンマ区切りリストにする必要があります。例: parent,resourceName。

次のフィールドがサポートされています。

  • resourceName
  • category
  • state
  • 親
readTime

string (Timestamp format)

検出結果のフィルタリング時に参照点として使用される時間。フィルタは、指定された時刻に存在する検出結果に限定され、その値は特定の時刻の値になります。このフィールドが指定されていない場合、デフォルトは API のバージョンの NOW になります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
pageToken

string

最後の GroupFindingsResponse で返された値は、これが前の findings.group 呼び出しの続きであり、システムからその次のページのデータが返される必要があることを示しています。
pageSize

integer

1 回のレスポンスで返される結果の最大件数。デフォルトは 10 で、最小値は 1、最大値は 1,000 です。

レスポンスの本文

検出結果のグループ化のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
フィールド
groupByResults[]

object (GroupResult)

結果をグループ化します。プロパティと値の一意の組み合わせごとに要素が存在します。この要素には、特定のプロパティ/値が出現する回数のカウントが含まれます。
readTime

string (Timestamp format)

groupBy リクエストの実行に使用された時間。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
nextPageToken

string

結果の次のページを取得するためのトークン。それ以上の結果がない場合は空です。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。