Method: projects.locations.instances.list

Lista as instâncias em determinado projeto e local.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai da instância. Formatos: - projects/{projectId}/locations/{location} para listar instâncias em uma zona específica. - projects/{projectId}/locations/- para listar instâncias em todos os locais.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • notebooks.instances.list

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho máximo de retorno da chamada de lista.
pageToken

string

Opcional. Um token de página retornado anteriormente que pode ser usado para continuar a listagem do último resultado.
orderBy

string

Opcional. Classificar resultados. Os valores aceitos são "name", "name desc" ou " "(unsorted)".
filter

string

Opcional. Filtro de lista.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para listar instâncias de notebook.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
instances[]

object (Instance)

Uma lista de instâncias retornadas.
nextPageToken

string

Token de página que pode ser usado para continuar a listagem do último resultado na próxima chamada de lista.
unreachable[]

string

Lista não ordenada. Locais que não puderam ser alcançados. Por exemplo, ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']. Um ListInstancesResponse só vai conter instâncias ou inacessíveis.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.