Method: projects.locations.list

Permite mostrar una lista con información sobre las ubicaciones compatibles con este servicio. Este método se puede llamar de dos maneras:

  • Enumera todas las ubicaciones públicas: Usa la ruta de acceso GET /v1/locations.
  • Enumera las ubicaciones visibles para el proyecto: Usa la ruta de acceso GET /v1/projects/{projectId}/locations. Esto puede incluir ubicaciones públicas, así como ubicaciones privadas o de otro tipo que sean específicamente visibles para el proyecto.

Solicitud HTTP

GET https://vectorsearch.googleapis.com/v1/{name}/locations

Parámetros de ruta

Parámetros
name

string

El recurso propietario de la colección de ubicaciones, si corresponde.

Parámetros de consulta

Parámetros
filter

string

Es un filtro para limitar los resultados a un subconjunto preferido. El lenguaje de filtrado acepta cadenas como "displayName=tokyo" y se documenta con más detalle en AIP-160.
pageSize

integer

La cantidad máxima de resultados que se mostrarán. Si no se configura, el servicio selecciona una configuración predeterminada.
pageToken

string

Es un token de página recibido del campo nextPageToken en la respuesta. Envía ese token de página para recibir la página siguiente.
extraLocationTypes[]

string

Es opcional. No uses este campo. No se admite y se ignora, a menos que se documente explícitamente lo contrario. Esto es principalmente para uso interno.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListLocationsResponse.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Permisos de IAM

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

  • vectorsearch.locations.list

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