Method: organizations.assets.group

Die Assets einer Organisation werden gefiltert und nach den angegebenen Attributen gruppiert.

HTTP-Anfrage


Die URLs verwenden die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Pflichtangabe. Name der Organisation, nach der gruppiert werden soll. Das Format lautet „organizations/[organization_id]“.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Ausdruck, der den Filter definiert, der auf alle Assets angewendet werden soll. Der Ausdruck besteht aus einer Liste mit null oder mehr 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. Die Felder stimmen mit den in der Asset-Ressource definierten überein. Hier einige Beispiele:

  • Name
  • securityCenterProperties.resource_name
  • resourceProperties.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

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

string

Pflichtangabe. Ausdruck, der festlegt, welche Asset-Felder für die Gruppierung verwendet werden sollen. Der Stringwert sollte in der SQL-Syntax als eine durch Komma getrennte Liste von Feldern angegeben sein. Beispiel: „securityCenterProperties.resource_project,securityCenterProperties.project“.

Die folgenden Felder werden unterstützt, wenn „compareDuration“ nicht festgelegt ist:

  • securityCenterProperties.resource_project
  • securityCenterProperties.resource_type
  • securityCenterProperties.resource_parent

Die folgenden Felder werden unterstützt, wenn „compareDuration“ festgelegt ist:

  • securityCenterProperties.resource_type
compareDuration

string (Duration format)

Wenn „compareDuration“ festgelegt ist, wird die Eigenschaft „state“ des Assets aktualisiert, um anzugeben, ob das Asset im Zeitraum „compareDuration“, der der „readTime“ vorausgeht, hinzugefügt, entfernt oder vorhanden war. Das ist die Zeit zwischen (readTime – compareDuration) und readTime.

Der Statuswert wird basierend auf der Präsenz des Assets zu den beiden Zeitpunkten abgeleitet. Zwischenzeitliche Statusänderungen zwischen den beiden Zeitpunkten wirken sich nicht auf das Ergebnis aus. Die Ergebnisse sind beispielsweise nicht betroffen, wenn das Asset entfernt und wieder erstellt wird.

Mögliche Werte für „state“, wenn „compareDuration“ angegeben ist:

  • „HINZUGEFÜGT“: gibt an, dass das Asset vor „compareDuration“ nicht vorhanden war, aber zu „reference_time“.
  • „ENTFERNT“: Das Asset war zu Beginn von „compareDuration“, aber nicht zu „reference_time“ vorhanden.
  • „AKTIV“: Das Asset war sowohl am Anfang als auch am Ende des Zeitraums vorhanden, der durch „compareDuration“ und „reference_time“ definiert ist.

Dieses Feld wird ignoriert, wenn state kein Feld in groupBy ist.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
readTime

string (Timestamp format)

Zeitpunkt, der beim Filtern von Assets als Referenzpunkt verwendet wird. Der Filter ist auf Assets beschränkt, die zum angegebenen Zeitpunkt vorhanden sind. Die Werte beziehen sich auf diesen bestimmten 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 GroupAssetsResponse zurückgegeben wurde. Gibt an, dass dies eine Fortsetzung eines vorherigen assets.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 Assets.

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.