Método: projects.locations.instances.list

Lista todas as instâncias do Redis pertencentes a um projeto no local especificado (região) ou em todos os locais.

O local deve ter o seguinte formato: * projects/{projectId}/locations/{locationId}

Se locationId for especificado como - (caractere curinga), todas as regiões disponíveis para o projeto serão consultadas e os resultados serão agregados.

Solicitação HTTP

GET https://redis.googleapis.com/v1/{parent=projects/*/locations/*}/instances

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do local da instância usando o formulário: projects/{projectId}/locations/{locationId}, em que locationId se refere a uma região do GCP

Parâmetros de consulta

Parâmetros
pageSize

number

O número máximo de itens para retornar.

Caso não seja especificado, um valor padrão de 1000 será usado pelo serviço. Independentemente do valor de pageSize, a resposta pode incluir uma lista parcial e um autor da chamada deve se basear apenas no [nextPageToken][CloudRedis.ListInstancesResponse.next_page_token] das respostas para determinar se ainda há mais instâncias a serem consultadas.
pageToken

string

O valor nextPageToken retornado de uma solicitação de lista anterior, se houver.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

Resposta para instances.list.

Representação JSON 

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

object(Instance)

Uma lista de instâncias do Redis no projeto no local especificado ou em todos os locais.

Se o locationId no campo pai da solicitação for "-", todas as regiões disponíveis para o projeto serão consultadas e os resultados serão agregados. Se, em uma consulta agregada, um local não estiver disponível, uma entrada do Redis fictícia será incluída na resposta com o campo "name" definido como um valor do formulário projects/{projectId}/locations/{locationId}/instances/-, o campo "status" definido como ERROR e o campo "statusMessage" definido como "local não disponível para instances.list".
nextPageToken

string

Token para recuperar a próxima página de resultados ou vazia se não houver mais resultados na lista.

unreachable[]

string

Locais que não puderam ser alcançados.

Escopos da autorização

Requer o seguinte escopo OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.