Method: projects.locations.instances.list

Liste les instances d'un projet et d'un emplacement donnés.

Requête HTTP

GET https://notebooks.googleapis.com/v2/{parent}/instances

Paramètres de chemin

Paramètres
parent

string

Obligatoire. Parent de l'instance. Formats : - projects/{projectId}/locations/{location} pour lister les instances dans une zone spécifique. - projects/{projectId}/locations/- pour lister les instances dans tous les emplacements.

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

  • notebooks.instances.list

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Taille de retour maximale de l'appel de liste.
pageToken

string

Facultatif. Jeton de page renvoyé précédemment et pouvant être utilisé pour continuer à lister à partir du dernier résultat.
orderBy

string

Facultatif. Tri des résultats. Les valeurs acceptées sont "name", "name desc" ou "" (non triées).
filter

string

Facultatif. Filtre de liste.

Corps de la requête

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

Corps de la réponse

Réponse pour la liste des instances de notebooks.

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

Représentation JSON 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
instances[]

object (Instance)

Liste des instances renvoyées.
nextPageToken

string

Jeton de page qui peut être utilisé pour continuer à lister à partir du dernier résultat lors du prochain appel de liste.
unreachable[]

string

Liste non triée. Emplacements inaccessibles. Par exemple, ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']. Une réponse ListInstancesResponse ne contient que des instances ou des instances inaccessibles.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.