Method: organizations.sources.findings.group

Hiermit werden die Ergebnisse einer Organisation oder Quelle gefiltert und nach den angegebenen Attributen gruppiert.

Wenn Sie eine Gruppierung für alle Quellen erstellen möchten, geben Sie - als Quell-ID an. Beispiel: /v1beta1/organizations/{organization_id}/sources/-/findings

HTTP-Anfrage


Die URLs verwenden die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Pflichtangabe. Name der Quelle, nach der gruppiert werden soll. Das Format lautet „organizations/[organization_id]/sources/[source_id]“. Wenn Sie die Gruppierung auf alle Quellen anwenden möchten, geben Sie „-“ als „source_id“ an. Beispiel: organizations/{organization_id}/sources/-

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "filter": string,
  "groupBy": string,
  "readTime": string,
  "pageToken": string,
  "pageSize": integer
}
Felder
filter

string

Ausdruck, der den Filter definiert, der auf alle Ergebnisse angewendet werden soll. Der Ausdruck besteht aus einer Liste mit einer oder mehreren Einschränkungen, die über die logischen Operatoren AND und OR kombiniert werden. Klammern werden nicht unterstützt und OR hat eine höhere Priorität als AND.

Einschränkungen haben das Format <field> <operator> <value> und können ein --Zeichen vorangestellt haben, um eine Verneinung anzugeben. Hier einige Beispiele:

  • Name
  • sourceProperties.a_property
  • securityMarks.marks.marka

Folgende Operatoren werden unterstützt:

  • = für alle Werttypen.
  • >, <, >=, <= für Ganzzahlwerte.
  • :, d. h. Teilstringabgleich, für Strings.

Folgende Werttypen werden unterstützt:

  • Stringliterale in Anführungszeichen.
  • Ganzzahlliterale ohne Anführungszeichen.
  • Boolesche Literale true und false ohne Anführungszeichen

sourceProperties.size = 100 ist beispielsweise ein gültiger Filterstring.
groupBy

string

Pflichtangabe. Ausdruck, der festlegt, welche Asset-Felder für die Gruppierung verwendet werden sollen (einschließlich state). Der Stringwert sollte der SQL-Syntax entsprechen: durch Kommas getrennte Liste von Feldern. Beispiel: „parent,resourceName“.

Die folgenden Felder werden unterstützt:

  • resourceName
  • Kategorie
  • Status
  • Übergeordnetes Element
readTime

string (Timestamp format)

Zeitpunkt, der beim Filtern von Ergebnissen als Referenzpunkt verwendet wird. Der Filter ist auf Ergebnisse beschränkt, die zum angegebenen Zeitpunkt vorhanden sind. Die Werte sind die zu diesem Zeitpunkt. Wenn dieses Feld nicht vorhanden ist, wird standardmäßig die Version von NOW der API verwendet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
pageToken

string

Der Wert, der vom letzten GroupFindingsResponse zurückgegeben wurde. Gibt an, dass dies eine Fortsetzung eines vorherigen findings.group-Aufrufs ist und dass das System die nächste Datenseite zurückgeben soll.
pageSize

integer

Die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen. Der Standardwert ist 10, der Mindestwert ist 1 und der Höchstwert ist 1.000.

Antworttext

Antwortnachricht für die Gruppierung nach Ergebnissen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
Felder
groupByResults[]

object (GroupResult)

Ergebnisse gruppieren Für jede eindeutige Kombination aus Property und Werten gibt es ein Element. Das Element enthält eine Zählung, wie oft diese bestimmten Unterkünfte/Werte vorkommen.
readTime

string (Timestamp format)

Zeit, die für die Ausführung der groupBy-Anfrage verwendet wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
nextPageToken

string

Token zum Abrufen der nächsten Ergebnisseite. Leer, wenn keine weiteren Ergebnisse vorhanden sind.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.