Method: projects.locations.list

Permite mostrar una lista con información sobre las ubicaciones compatibles con este servicio.

Este método muestra ubicaciones según el alcance del recurso proporcionado en el campo ListLocationsRequest.name:

  • Ubicaciones globales: Si name está vacío, el método muestra las ubicaciones públicas disponibles para todos los proyectos.
  • Ubicaciones específicas del proyecto: Si name sigue el formato projects/{project}, el método muestra las ubicaciones visibles para ese proyecto específico. Esto incluye ubicaciones públicas, privadas o de otro tipo específicas del proyecto habilitadas para el proyecto.

Para las implementaciones de gRPC y de la biblioteca cliente, el nombre del recurso se pasa como el campo name. Para las llamadas directas al servicio, el nombre del recurso se incorpora a la ruta de acceso de la solicitud según la implementación y la versión específicas del servicio.

Solicitud HTTP

GET https://ces.googleapis.com/v1beta/{name=projects/*}/locations

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

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 a menos que se documente explícitamente lo contrario. Es principalmente para uso interno.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

El mensaje de respuesta para Locations.ListLocations.

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

Representación JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Campos
locations[]

object (Location)

Una lista de ubicaciones que coincide con el filtro especificado en la solicitud.
nextPageToken

string

El token de página siguiente de lista estándar.

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/ces

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

Permisos de IAM

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

  • ces.locations.list

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