Method: organizations.assets.group

Filtra gli asset di un'organizzazione e li raggruppa in base alle proprietà specificate.

Richiesta HTTP


Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Nome dell'organizzazione da aggregare. Il formato è "organizations/[organization_id]".

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

string

Espressione che definisce il filtro da applicare agli asset. L'espressione è un elenco di zero 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. I campi vengono mappati a quelli definiti nella risorsa Asset. Ecco alcuni esempi:

  • nome
  • securityCenterProperties.resource_name
  • resourceProperties.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, resourceProperties.size = 100 è una stringa filtro valida.
groupBy

string

Obbligatorio. Espressione che definisce i campi degli asset da utilizzare per il raggruppamento. Il valore della stringa deve seguire la sintassi SQL: elenco di campi separati da virgole. Ad esempio: "securityCenterProperties.resource_project,securityCenterProperties.project".

I seguenti campi sono supportati quando compareDuration non è impostato:

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

Quando viene impostato compareDuration, sono supportati i seguenti campi:

  • securityCenterProperties.resource_type
compareDuration

string (Duration format)

Quando compareDuration è impostato, la proprietà "state" dell'asset viene aggiornata per indicare se l'asset è stato aggiunto, rimosso o è rimasto presente durante il periodo di tempo di compareDuration che precede il momento readTime. Si tratta del tempo tra (readTime - compareDuration) e readTime.

Il valore dello stato viene dedotto in base alla presenza della risorsa nei due punti nel tempo. Le modifiche dello stato intermedio tra i due momenti non influiscono sul risultato. Ad esempio, i risultati non sono interessati se l'asset viene rimosso e ricreato di nuovo.

Possibili valori di "state" quando viene specificato compareDuration:

  • "AGGIUNTO": indica che la risorsa non era presente prima di compareDuration, ma era presente in reference_time.
  • "RIMOSSO": indica che la risorsa era presente all'inizio di compareDuration, ma non al momento reference_time.
  • "ACTIVE": indica che la risorsa era presente sia all'inizio che alla fine del periodo di tempo definito da compareDuration e reference_time.

Questo campo viene ignorato se state non è un campo in groupBy.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
readTime

string (Timestamp format)

Ora utilizzata come punto di riferimento per filtrare gli asset. Il filtro è limitato alle risorse 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 GroupAssetsResponse; indica che si tratta della continuazione di una chiamata assets.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 il raggruppamento per asset.

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.