Method: projects.locations.instances.list

Enumera las instancias en una ubicación y un proyecto determinados.

Solicitud HTTP

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el elemento superior de la instancia. Formatos: - projects/{projectId}/locations/{location} para enumerar instancias en una zona específica. - projects/{projectId}/locations/- para enumerar instancias en todas las ubicaciones

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.instances.list

Parámetros de consulta

Parámetros
pageSize

integer

Es opcional. Es el tamaño máximo de devolución de la llamada de lista.
pageToken

string

Es opcional. Es un token de página devuelto anteriormente que se puede usar para continuar la lista desde el último resultado.
orderBy

string

Es opcional. Ordena resultados. Los valores admitidos son “name”, “name desc” o “” (sin orden).
filter

string

Es opcional. Es un filtro de lista.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta para enumerar instancias de notebooks.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
instances[]

object (Instance)

Es una lista de instancias devueltas.
nextPageToken

string

Es un token de página que se puede usar para continuar la lista desde el último resultado en la siguiente llamada a la lista.
unreachable[]

string

Lista sin ordenar. Ubicaciones a las que no se pudo llegar. Por ejemplo, ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']. Un ListInstancesResponse solo contendrá instancias o elementos no accesibles.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.