Method: projects.locations.instances.list

Listet Instanzen in einem bestimmten Projekt und an einem bestimmten Standort auf.

HTTP-Anfrage

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

Pfadparameter

Parameter
parent

string

Erforderlich. Das übergeordnete Element der Instanz. Format: - projects/{projectId}/locations/{location}, um Instanzen in einer bestimmten Zone aufzulisten. – projects/{projectId}/locations/-, um Instanzen an allen Standorten aufzulisten.

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent:

  • notebooks.instances.list

Suchparameter

Parameter
pageSize

integer

Optional. Maximale Rückgabegröße des Listenaufrufs.
pageToken

string

Optional. Ein zuvor zurückgegebenes Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis fortzusetzen.
orderBy

string

Optional. Ergebnisse sortieren. Unterstützte Werte sind "name", "name desc" oder "" (nicht sortiert).
filter

string

Optional. Listenfilter.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für das Auflisten von Notebook-Instanzen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Felder
instances[]

object (Instance)

Eine Liste der zurückgegebenen Instanzen.
nextPageToken

string

Seitentoken, das verwendet werden kann, um die Auflistung im nächsten Listenaufruf ab dem letzten Ergebnis fortzusetzen.
unreachable[]

string

Unsortierte Liste. Standorte, die nicht erreicht werden konnten. Beispiel: ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']. Eine ListInstancesResponse enthält entweder Instanzen oder nicht erreichbare Elemente.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.