Method: projects.locations.instances.list

Lista instâncias em um determinado projeto e local.

Solicitação HTTP

GET https://memorystore.googleapis.com/v1alpha/{parent=projects/*/locations/*}/instances

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai das instâncias que serão listadas. Formato: projects/{project}/locations/{location}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.

pageToken

string

Opcional. Um token que identifica a página de resultados que o servidor retornará.

filter

string

Opcional. Expressão para filtrar resultados.

orderBy

string

Opcional. Classifique os resultados em uma ordem definida. Valores aceitos: "name", "createTime".

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para [instances.list][].

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)

Se o {location} solicitado for "-", a resposta conterá uma lista de instâncias de todos os locais. As instâncias em locais inacessíveis serão omitidas.

nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

unreachable[]

string

Locais que não puderam ser alcançados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • memorystore.instances.list

Para mais informações, consulte a documentação do IAM.