Method: projects.locations.clusters.list

Lista todos os clusters do Redis pertencentes a um projeto na localização (região) especificada ou em todas as localizações.

A localização deve ter o seguinte formato:

  • projects/{projectId}/locations/{locationId}

Se locationId for especificado como - (caráter universal), são consultadas todas as regiões disponíveis para o projeto e os resultados são agregados.

Pedido HTTP

GET https://redis.googleapis.com/v1beta1/{parent=projects/*/locations/*}/clusters

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da localização do cluster com o formato: projects/{projectId}/locations/{locationId}, em que locationId se refere a uma região do Google Cloud.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de itens a devolver.

Se não for especificado, o serviço usa um valor predefinido de 1000. Independentemente do valor de pageSize, a resposta pode incluir uma lista parcial, e um autor da chamada só deve basear-se no nextPageToken da resposta para determinar se existem mais clusters a consultar.
pageToken

string

O valor nextPageToken devolvido de um pedido [clusters.list][CloudRedis.ListClusters] anterior, se existir.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Resposta para [clusters.list][CloudRedis.ListClusters].

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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

object (Cluster)

Uma lista de clusters do Redis no projeto na localização especificada ou em todas as localizações.

Se o locationId no campo principal do pedido for "-", são consultadas todas as regiões disponíveis para o projeto e os resultados são agregados. Se, numa consulta agregada, uma localização estiver indisponível, é incluída uma entrada Redis de marcador de posição na resposta com o campo name definido como um valor do formulário projects/{projectId}/locations/{locationId}/clusters/- e o campo status definido como ERROR e o campo statusMessage definido como "location not available for clusters.list".
nextPageToken

string

Token para obter a página seguinte de resultados ou vazio se não existirem mais resultados na lista.
unreachable[]

string

Localizações às quais não foi possível aceder.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.