Method: organizations.assets.list

Répertorie les éléments d'une organisation.

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 à laquelle les composants doivent appartenir. Il doit être au format "organizations/[organization_id]".

Paramètres de requête

Paramètres
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.

orderBy

string

Expression qui définit les champs et l'ordre à utiliser pour le tri. La valeur de chaîne doit respecter la syntaxe SQL: liste de champs séparés par une virgule. Par exemple: "name,resourceProperties.a_property". L'ordre de tri par défaut est croissant. Pour spécifier un ordre décroissant pour un champ, le suffixe "desc" doit être ajouté au nom du champ. Par exemple: "name desc,resourceProperties.a_property". Les espaces doubles dans la syntaxe sont sans conséquence. "name desc,resourceProperties.a_property" et " name desc , resourceProperties.a_property " sont équivalents.

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".

compareDuration

string (Duration format)

Lorsque compareDuration est défini, l'attribut "state" de ListAssetResult est mis à jour pour indiquer si l'élément 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 lecture.
  • "REMOVED": indique que l'élément était présent au début de compareDuration, mais pas à readTime.
  • "ACTIVE": indique que l'élément était présent au début et à la fin de la période définie par "compareDuration" et "readTime".

Si compareDuration n'est pas spécifié, le seul état possible est "UNUSED", ce qui indique que l'élément est présent au moment de la lecture.

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

fieldMask

string (FieldMask format)

Facultatif. Masque de champ permettant de spécifier les champs ListAssetsResult à répertorier dans la réponse. Un masque de champ vide liste tous les champs.

pageToken

string

La valeur renvoyée par le dernier ListAssetsResponse indique qu'il s'agit de la continuation d'un appel assets.list 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 requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la liste des composants.

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

Représentation JSON
{
  "listAssetsResults": [
    {
      object (ListAssetsResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string,
  "totalSize": integer
}
Champs
listAssetsResults[]

object (ListAssetsResult)

Composants correspondant à la requête de liste.

readTime

string (Timestamp format)

Temps utilisé pour exécuter la requête de liste.

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.

totalSize

integer

Nombre total d'éléments correspondant à la requête.

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.

ListAssetsResult

Résultat contenant l'asset et son état.

Représentation JSON
{
  "asset": {
    object (Asset)
  },
  "state": enum (State)
}
Champs
asset

object (Asset)

Composant correspondant à la requête de recherche.

state

enum (State)

État de l'élément.

Élément

Représentation d'une ressource Google Cloud dans Security Command Center.

L'élément est une ressource Security Command Center qui collecte des informations sur une seule ressource Google Cloud. Toutes les modifications apportées à un élément ne s'appliquent qu'au contexte de Security Command Center et n'affectent pas la ressource Google Cloud référencée.

Représentation JSON
{
  "name": string,
  "securityCenterProperties": {
    object (SecurityCenterProperties)
  },
  "resourceProperties": {
    string: value,
    ...
  },
  "securityMarks": {
    object (SecurityMarks)
  },
  "createTime": string,
  "updateTime": string
}
Champs
name

string

Nom de ressource relatif de cet élément. Voir https://cloud.google.com/apis/design/resource_names#relative_resource_name. Exemple : "organizations/{organization_id}/assets/{asset_id}".

securityCenterProperties

object (SecurityCenterProperties)

Propriétés gérées par Security Command Center Ces propriétés sont gérées par Security Command Center et ne peuvent pas être modifiées par l'utilisateur.

resourceProperties

map (key: string, value: value (Value format))

Propriétés gérées par les ressources. Ces propriétés sont gérées et définies par la ressource Google Cloud et ne peuvent pas être modifiées par l'utilisateur.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

securityMarks

object (SecurityMarks)

Marques de sécurité spécifiées par l'utilisateur. Ces marques sont entièrement gérées par l'utilisateur et proviennent de la ressource SecurityMarks appartenant à l'élément.

createTime

string (Timestamp format)

Heure à laquelle l'élément a été créé dans Security Command Center.

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".

updateTime

string (Timestamp format)

Heure à laquelle l'élément a été mis à jour, ajouté ou supprimé pour la dernière fois dans Security Command Center.

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".

SecurityCenterProperties

Propriétés gérées par Security Command Center Ces propriétés sont gérées par Security Command Center et ne peuvent pas être modifiées par l'utilisateur.

Représentation JSON
{
  "resourceName": string,
  "resourceType": string,
  "resourceParent": string,
  "resourceProject": string,
  "resourceOwners": [
    string
  ]
}
Champs
resourceName

string

Immuable. Nom complet de la ressource Google Cloud représentée par cet élément. Ce champ est immuable après l'heure de création. Voir https://cloud.google.com/apis/design/resource_names#full_resource_name.

resourceType

string

Type de la ressource Google Cloud. Exemples: APPLICATION, PROJECT et ORGANIZATION. Il s'agit d'un champ insensible à la casse défini par Security Command Center et/ou le producteur de la ressource. Il est immuable après la création.

resourceParent

string

Nom complet de la ressource parente immédiate de la ressource. Voir https://cloud.google.com/apis/design/resource_names#full_resource_name.

resourceProject

string

Nom complet de la ressource du projet auquel elle appartient. Voir https://cloud.google.com/apis/design/resource_names#full_resource_name.

resourceOwners[]

string

Propriétaires de la ressource Google Cloud.

État

État de l'élément.

Lorsque vous effectuez une requête sur deux points dans le temps, cette valeur décrit le changement entre les deux points: ADDED (AJOUTÉ), REMOVED (SUPPRIMÉ) ou ACTIVE (ACTIF). Si aucune valeur n'a été fournie pour "compareDuration" dans la requête, l'état doit être "UNUSED".

Enums
STATE_UNSPECIFIED État non spécifié.
UNUSED La requête n'a pas spécifié l'utilisation de ce champ dans le résultat.
ADDED L'élément a été ajouté entre les points de temps.
REMOVED L'élément a été supprimé entre les deux points dans le temps.
ACTIVE L'asset était actif aux deux moments.