Method: organizations.sources.findings.group

Filtra i risultati di un'organizzazione o di un'origine e li raggruppa in base alle proprietà specificate.

Per raggruppare tutti i dati in base a tutte le origini, specifica - come ID origine. Esempio: /v1beta1/organizations/{organization_id}/sources/-/findings

Richiesta HTTP


Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Nome dell'origine da aggregare. Il formato è "organizations/[organization_id]/sources/[source_id]". Per eseguire il raggruppamento in base a tutte le origini, specifica un valore source_id pari a -. Ad esempio: organizations/{organization_id}/sources/-

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "filter": string,
  "groupBy": string,
  "readTime": string,
  "pageToken": string,
  "pageSize": integer
}
Campi
filter

string

Espressione che definisce il filtro da applicare ai risultati. L'espressione è un elenco di una o più limitazioni combinate tramite gli operatori logici AND e OR. Le parentesi non sono supportate e OR ha una precedenza maggiore rispetto a AND.

Le limitazioni hanno il formato <field> <operator> <value> e possono essere precedute dal carattere - per indicare la negazione. Ecco alcuni esempi:

  • nome
  • sourceProperties.a_property
  • securityMarks.marks.marka

Gli operatori supportati sono:

  • = per tutti i tipi di valori.
  • >, <, >=, <= per valori interi.
  • :, che indica la corrispondenza sottostringa, per le stringhe.

I tipi di valori supportati sono:

  • Valori letterali stringa tra virgolette.
  • letterali interi senza virgolette.
  • Valori letterali booleani true e false senza virgolette.

Ad esempio, sourceProperties.size = 100 è una stringa filtro valida.

groupBy

string

Obbligatorio. Espressione che definisce i campi delle risorse da utilizzare per il raggruppamento (incluso state). Il valore della stringa deve seguire la sintassi SQL: elenco di campi separati da virgola. Ad esempio: "parent,resourceName".

Sono supportati i seguenti campi:

  • resourceName
  • categoria
  • state
  • principale
readTime

string (Timestamp format)

Ora utilizzata come punto di riferimento per filtrare i risultati. Il filtro è limitato ai risultati esistenti al momento specificato e i relativi valori sono quelli in quel momento specifico. In assenza di questo campo, verrà utilizzata per impostazione predefinita la versione di NOW dell'API.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

pageToken

string

Il valore restituito dall'ultimo GroupFindingsResponse; indica che si tratta della continuazione di una chiamata findings.group precedente e che il sistema deve restituire la pagina di dati successiva.

pageSize

integer

Il numero massimo di risultati da restituire in una singola risposta. Il valore predefinito è 10, il minimo è 1 e il massimo è 1000.

Corpo della risposta

Messaggio di risposta per i risultati raggruppati.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
Campi
groupByResults[]

object (GroupResult)

Raggruppa i risultati. Esiste un elemento per ogni combinazione univoca esistente di proprietà/valori. L'elemento contiene un conteggio del numero di volte in cui vengono visualizzate queste proprietà/valori specifici.

readTime

string (Timestamp format)

Tempo utilizzato per l'esecuzione della richiesta groupBy.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

nextPageToken

string

Token per recuperare la pagina di risultati successiva o vuoto se non ci sono altri risultati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la sezione Authentication Overview.