Method: projects.locations.clusters.list

Enumera todos los clústeres de Redis que son propiedad de 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 se especifica locationId como - (comodín), se consultan todas las regiones disponibles para el proyecto y se agregan los resultados.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación 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}, en el que locationId hace referencia a una región de Google Cloud.

Parámetros de consulta

Parámetros
pageSize

integer

La cantidad máxima de elementos que se mostrarán.

Si no se especifica, el servicio usará un valor predeterminado de 1,000. Sin importar el valor de pageSize, la respuesta puede incluir una lista parcial, y un emisor solo debe confiar en el nextPageToken de la respuesta para determinar si quedan más clústeres para consultar.
pageToken

string

El valor de nextPageToken que se muestra de una solicitud clusters.list previa, si existe.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta para clusters.list.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (Cluster)

Es una lista de clústeres de Redis en el proyecto, en la ubicación especificada o en todas las ubicaciones.

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

string

Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.
unreachable[]

string

Ubicaciones a las que no se pudo llegar.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

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