Method: projects.locations.instances.list

Enumera instancias en una ubicación y un proyecto determinados.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el elemento superior desde el que se enumeran las instancias. Formato: projects/{project}/locations/{location}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los solicitados. Si no se especifica, el servidor elegirá una configuración predeterminada adecuada.

pageToken

string

Opcional. Un token que identifica una página de resultados que debe mostrar el servidor.

filter

string

Opcional. Es la expresión para filtrar los resultados.

orderBy

string

Opcional. Ordena los resultados según un orden definido. Valores admitidos: "name", "createTime".

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para [instances.list][]. Es la lista de instancias en la ubicación especificada.

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

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

object (Instance)

Si el {location} solicitado fue “-”, la respuesta contiene una lista de instancias de todas las ubicaciones. Se omitirán las instancias en ubicaciones inaccesibles.

nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

unreachable[]

string

Ubicaciones en las que no se pudo acceder.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • memorystore.instances.list

Para obtener más información, consulta la documentación de IAM.