Method: projects.locations.clusters.list

Muestra todos los clústeres de Redis que pertenecen a un proyecto en la ubicación (región) especificada o en todas las ubicaciones.

La ubicación debe tener el siguiente formato:

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

Si locationId se especifica como - (comodín), se consultan todas las regiones disponibles para el proyecto y se agregan los resultados.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso de la ubicación del clúster con el formato projects/{projectId}/locations/{locationId}, donde locationId hace referencia a una región de Google Cloud.

Los parámetros de consulta

Parámetros
pageSize

integer

Número máximo de elementos que se devolverán.

Si no se especifica, el servicio usará el valor predeterminado 1000. Independientemente del valor de pageSize, la respuesta puede incluir una lista parcial y el llamador solo debe usar nextPageToken de la respuesta para determinar si quedan más clústeres por consultar.
pageToken

string

El valor nextPageToken devuelto por una solicitud [clusters.list][CloudRedis.ListClusters] anterior, si la hay.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta de [clusters.list][CloudRedis.ListClusters].

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (Cluster)

Lista de clústeres de Redis del proyecto en la ubicación especificada o en todas las ubicaciones.

Si el valor de locationId del campo superior de la solicitud es "-", se consultarán todas las regiones disponibles para el proyecto y se agregarán los resultados. Si en una consulta agregada de este tipo no hay disponible una ubicación, se incluye en la respuesta una entrada de Redis con el campo name definido con un valor del formulario projects/{projectId}/locations/{locationId}/clusters/- y el campo status definido como ERROR y el campo statusMessage definido como "location not available for clusters.list".
nextPageToken

string

Token para obtener la siguiente página de resultados. Si no hay más resultados en la lista, se devuelve un valor vacío.
unreachable[]

string

Ubicaciones a las que no se ha podido acceder.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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