Method: organizations.assets.group

Filtre les éléments d'une organisation et les regroupe en fonction de leurs propriétés spécifiées.

Requête HTTP


Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de l'organisation à regrouper. Il doit être au format "organizations/[organization_id]".

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "filter": string,
  "groupBy": string,
  "compareDuration": string,
  "readTime": string,
  "pageToken": string,
  "pageSize": integer
}
Champs
filter

string

Expression qui définit le filtre à appliquer aux composants. L'expression est une liste de zéro ou plusieurs restrictions combinées à l'aide des opérateurs logiques AND et OR. Les parenthèses ne sont pas acceptées, et OR a une priorité plus élevée que AND.

Les restrictions ont la forme <field> <operator> <value> et peuvent être précédées d'un caractère - pour indiquer une négation. Les champs correspondent à ceux définis dans la ressource Asset. Voici quelques exemples :

  • nom
  • securityCenterProperties.resource_name
  • resourceProperties.a_property
  • securityMarks.marks.marka

Les opérateurs compatibles sont les suivants:

  • = pour tous les types de valeurs.
  • >, <, >=, <= pour les valeurs entières.
  • :, qui signifie "mise en correspondance de sous-chaîne", pour les chaînes.

Les types de valeurs acceptés sont les suivants:

  • littéraux de chaîne entre guillemets.
  • des littéraux entiers sans guillemets.
  • Les littéraux booléens true et false sans guillemets.

Par exemple, resourceProperties.size = 100 est une chaîne de filtre valide.
groupBy

string

Obligatoire. Expression qui définit les champs de composants à utiliser pour le regroupement. La valeur de chaîne doit respecter la syntaxe SQL: liste de champs séparés par une virgule. Par exemple: "securityCenterProperties.resource_project,securityCenterProperties.project".

Les champs suivants sont acceptés lorsque compareDuration n'est pas défini:

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

Les champs suivants sont acceptés lorsque compareDuration est défini:

  • securityCenterProperties.resource_type
compareDuration

string (Duration format)

Lorsque compareDuration est défini, la propriété "state" de l'élément est mise à jour pour indiquer s'il a été ajouté, supprimé ou est resté présent pendant la période de compareDuration qui précède le readTime. Il s'agit du temps écoulé entre (readTime - compareDuration) et readTime.

La valeur d'état est dérivée de la présence de l'asset aux deux moments. Les changements d'état intermédiaires entre les deux moments n'ont aucune incidence sur le résultat. Par exemple, les résultats ne sont pas affectés si l'asset est supprimé et recréée.

Valeurs "state" possibles lorsque compareDuration est spécifié:

  • "ADDED": indique que l'asset n'était pas présent avant la valeur de compareDuration, mais qu'il l'était à l'heure de référence.
  • "REMOVED": indique que l'asset était présent au début de compareDuration, mais pas à reference_time.
  • "ACTIVE": indique que l'élément était présent au début et à la fin de la période définie par "compareDuration" et "reference_time".

Ce champ est ignoré si state n'est pas un champ de groupBy.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
readTime

string (Timestamp format)

Heure utilisée comme point de référence lors du filtrage des composants. Le filtre est limité aux éléments existants au moment indiqué, et leurs valeurs correspondent à celles de ce moment précis. Si ce champ n'est pas spécifié, la version de l'API de NOW est utilisée par défaut.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
pageToken

string

La valeur renvoyée par le dernier GroupAssetsResponse indique qu'il s'agit de la continuation d'un appel assets.group précédent et que le système doit renvoyer la page de données suivante.
pageSize

integer

Nombre maximal de résultats à renvoyer dans une seule réponse. La valeur par défaut est 10. Elle doit être comprise entre 1 et 1 000 (inclus).

Corps de la réponse

Message de réponse pour le regroupement par composants.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "groupByResults": [
    {
      object (GroupResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string
}
Champs
groupByResults[]

object (GroupResult)

Regrouper les résultats Un élément existe pour chaque combinaison unique de propriété/valeurs. L'élément contient le nombre d'occurrences de ces propriétés/valeurs spécifiques.
readTime

string (Timestamp format)

Temps utilisé pour exécuter la requête groupBy.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
nextPageToken

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez Authentication Overview.