Method: projects.locations.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists information about the supported locations for this service.
HTTP request
GET https://privateca.googleapis.com/v1/{name=projects/*}/locations
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The resource that owns the locations collection, if applicable.
|
Query parameters
| Parameters |
filter |
string
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
|
pageSize |
integer
The maximum number of results to return. If not set, the service selects a default.
|
pageToken |
string
A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
|
Request body
The request body must be empty.
Response body
The response message for Locations.ListLocations.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"locations": [
{
object (Location)
}
],
"nextPageToken": string
} |
| Fields |
locations[] |
object (Location)
A list of locations that matches the specified filter in the request.
|
nextPageToken |
string
The standard List next-page token.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-06 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-06 UTC."],[[["This webpage details how to list supported locations for the service, focusing on the HTTP request method and the required parameters."],["The `GET` HTTP method is used to retrieve the locations, with the URL following a specific `gRPC Transcoding` syntax and requiring a path parameter `name` to specify the resource owner."],["Query parameters, including `filter`, `pageSize`, and `pageToken`, are available to refine the search results."],["The request body must be empty, and the successful response will be in JSON format, containing an array of location objects and an optional `nextPageToken` for pagination."],["The request requires OAuth scope `https://www.googleapis.com/auth/cloud-platform` to proceed."]]],[]]
