Method: projects.configs.variables.list

Répertorie les variables d'une configuration donnée correspondant aux filtres fournis. Cette commande ne liste que les noms de variables, et non les valeurs, sauf si returnValues est défini sur "True". Dans ce cas, seules les variables pour lesquelles l'utilisateur dispose d'une autorisation IAM pour variables.get sont renvoyées.

Requête HTTP

GET https://runtimeconfig.googleapis.com/v1beta1/{parent=projects/*/configs/*}/variables

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Chemin d'accès à la ressource RuntimeConfig pour laquelle vous souhaitez lister les variables. La configuration doit exister au préalable. Le chemin d'accès doit respecter le format suivant:

projects/[PROJECT_ID]/configs/[CONFIG_NAME]

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

  • runtimeconfig.variables.list

Paramètres de requête

Paramètres
filter

string

Filtre les variables en fonction du filtre spécifié. Exemple :

projects/example-project/config/[CONFIG_NAME]/variables/example-variable.
pageSize

number

Spécifie le nombre de résultats à renvoyer par page. Si le nombre d'éléments est inférieur au nombre spécifié, tous les éléments sont renvoyés.

pageToken

string

Spécifie un jeton de page à utiliser. Définissez pageToken sur un nextPageToken renvoyé par une requête de liste précédente pour obtenir la page de résultats suivante.

returnValues

boolean

L'indicateur indique si l'utilisateur souhaite renvoyer les valeurs des variables. Si la valeur est "True", seules les variables pour lesquelles l'utilisateur dispose de l'autorisation IAM variables.get sont renvoyées avec leurs valeurs.

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 :

Réponse pour la méthode variables.list().

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

object(Variable)

Liste des variables et de leurs valeurs. L'ordre des objets de variable renvoyés est arbitraire.

nextPageToken

string

Ce jeton vous permet d'obtenir la page de résultats suivante pour les requêtes de liste. Si le nombre de résultats est supérieur à pageSize, utilisez nextPageToken comme valeur pour le paramètre de requête pageToken dans la prochaine requête de liste. Les requêtes de liste ultérieures auront leur propre nextPageToken pour continuer à faire défiler les résultats.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.

Essayer