Method: organizations.protectedResources.search

Renvoie des métadonnées sur les ressources protégées par le CryptoKey Cloud KMS donné dans l'organisation Cloud donnée.

Requête HTTP

GET https://kmsinventory.googleapis.com/v1/{scope=organizations/*}/protectedResources:search

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
scope

string

Obligatoire. Nom de ressource de l'organisation. Exemple: organisations/123

L'autorisation IAM suivante est requise pour la ressource scope indiquée :

  • cloudkms.protectedResources.search

Paramètres de requête

Paramètres
cryptoKey

string

Obligatoire. Nom de ressource de CryptoKey.

L'autorisation IAM suivante est requise pour la ressource cryptoKey indiquée :

  • cloudkms.cryptoKeys.get
pageSize

integer

Nombre maximal de ressources à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 500 ressources au maximum seront renvoyées. La valeur maximale est 500. Les valeurs supérieures à 500 sont forcées à 500.

pageToken

string

Jeton de page reçu d'un appel KeyTrackingService.SearchProtectedResources précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à KeyTrackingService.SearchProtectedResources doivent correspondre à l'appel ayant fourni le jeton de page.

resourceTypes[]

string

Facultatif. Liste des types de ressources recherchés par cette requête. Si ce champ est vide, la recherche porte sur tous les types de ressources pouvant faire l'objet d'un suivi.

Les expressions régulières sont également acceptées. Exemple :

  • Ressources d'instantanés compute.googleapis.com.* dont le type commence par compute.googleapis.com.
  • .*Image ressources d'instantanés dont le type se termine par Image.
  • Ressources d'instantanés .*Image.* dont le type contient Image.

Consultez la page RE2 pour connaître la syntaxe d'expression régulière acceptée. Si l'expression régulière ne correspond à aucun type de ressource compatible, une erreur INVALID_ARGUMENT sera renvoyée.

Corps de la requête

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

Corps de la réponse

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

Message de réponse pour KeyTrackingService.SearchProtectedResources.

Représentation JSON
{
  "protectedResources": [
    {
      object (ProtectedResource)
    }
  ],
  "nextPageToken": string
}
Champs
protectedResources[]

object (ProtectedResource)

Ressources protégées pour cette page.

nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

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 la page Présentation de l'authentification.