Method: projects.sources.locations.findings.group

Filtre les résultats d'une organisation ou d'une source, et les regroupe en fonction de leurs propriétés spécifiées dans un emplacement. Si aucun emplacement n'est spécifié, les résultats sont considérés comme globaux.

Pour regrouper toutes les sources, indiquez - comme ID de source. La liste suivante présente quelques exemples:

  • /v2/organizations/{organization_id}/sources/-/findings + /v2/organizations/{organization_id}/sources/-/locations/{locationId}/findings
  • /v2/folders/{folder_id}/sources/-/findings
  • /v2/folders/{folder_id}/sources/-/locations/{locationId}/findings
  • /v2/projects/{projectId}/sources/-/findings
  • /v2/projects/{projectId}/sources/-/locations/{locationId}/findings

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 la source à grouper. Si aucun emplacement n'est spécifié, la recherche est considérée comme globale. La liste suivante présente quelques exemples:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[locationId]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[locationId]
  • projects/[projectId]/sources/[source_id]
  • projects/[projectId]/sources/[source_id]/locations/[locationId]

Pour grouper par source pour toutes les sources, spécifiez un identifiant de source de -. La liste suivante présente quelques exemples:

  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/[locationId]
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-/locations/[locationId]
  • projects/{projectId}/sources/-
  • projects/{projectId}/sources/-/locations/[locationId]

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,
  "pageToken": string,
  "pageSize": integer
}
Champs
filter

string

Expression qui définit le filtre à appliquer aux résultats. L'expression est une liste d'une ou plusieurs restrictions combinées à l'aide des opérateurs logiques AND et OR. Les parenthèses sont 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. Voici quelques exemples :

  • nom
  • 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.

Les combinaisons de champs et d'opérateurs suivantes sont acceptées:

  • nom : =
  • parent: =, :
  • resourceName: =, :
  • state: =, :
  • catégorie: =, :
  • externalUri: =, :
  • eventTime: =, >, <, >=, <=

Utilisation: doit être exprimé en millisecondes depuis l'epoch ou en tant que chaîne RFC3339. Exemples: eventTime = "2019-06-10T16:07:18-07:00" eventTime = 1560208038000

  • severity: =, :
  • securityMarks.marks: =, :
  • resource:
  • resource.name: =, :
  • resource.parent_name: =, :
  • resource.parent_display_name: =, :
  • resource.project_name: =, :
  • resource.project_display_name: =, :
  • resource.type: =, :
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: "parent,resourceName".
pageToken

string

La valeur renvoyée par le dernier GroupFindingsResponse indique qu'il s'agit de la continuation d'un appel findings.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

Si la requête aboutit, le corps de la réponse contient une instance de GroupFindingsResponse.

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.