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], folders/[folder_id] o projects/[projectId]".

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 sono supportate e OR ha la precedenza su 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.

Sono supportate le seguenti combinazioni di campi e operatori:

  • nome: =
  • updateTime: =, >, <, >=, <=

Utilizzo: deve essere espresso in millisecondi dall'epoca o in una stringa RFC3339. Esempi: updateTime = "2019-06-10T16:07:18-07:00" updateTime = 1560208038000

  • createTime: =, >, <, >=, <=

Utilizzo: deve essere espresso in millisecondi dall'epoca o in una stringa RFC3339. Esempi: createTime = "2019-06-10T16:07:18-07:00" createTime = 1560208038000

  • iamPolicy.policy_blob: =, :
  • resourceProperties: =, :, >, <, >=, <=
  • securityMarks.marks: =, :
  • securityCenterProperties.resource_name: =, :
  • securityCenterProperties.resource_name_display_name: =, :
  • securityCenterProperties.resource_type: =, :
  • securityCenterProperties.resource_parent: =, :
  • securityCenterProperties.resource_parent_display_name: =, :
  • securityCenterProperties.resource_project: =, :
  • securityCenterProperties.resource_project_display_name: =, :
  • securityCenterProperties.resource_owners: =, :

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

Utilizza una corrispondenza parziale con la stringa vuota per filtrare in base a una proprietà esistente: resourceProperties.my_property : ""

Utilizza una corrispondenza parziale negata sulla stringa vuota per filtrare in base a una proprietà non esistente: -resourceProperties.my_property : ""
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_project_display_name
  • securityCenterProperties.resource_type
  • securityCenterProperties.resource_parent
  • securityCenterProperties.resource_parent_display_name

Quando viene impostato compareDuration, sono supportati i seguenti campi:

  • securityCenterProperties.resource_type
  • securityCenterProperties.resource_project_display_name
  • securityCenterProperties.resource_parent_display_name
compareDuration

string (Duration format)

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

Il valore della variazione di 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 "stateChange" quando viene specificato compareDuration:

  • "AGGIUNTO": indica che l'asset non era presente all'inizio 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.

Se compareDuration non è specificato, l'unico possibile valore di stateChange è "UNUSED", che sarà lo stato impostato per tutti gli asset presenti al momento readTime.

Se questo campo è impostato, stateChange deve essere un campo specificato 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

In caso di esito positivo, il corpo della risposta contiene un'istanza di GroupAssetsResponse.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la sezione Authentication Overview.