GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/cloudLocations:search

Searches for cloud locations from a given source location.

Request

  • Base URL
    https://cloudlocationfinder.googleapis.com
  • URL
    https://cloudlocationfinder.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/cloudLocations:search
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

Query parameters

pageSizeinteger

Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, at most 500 cloud locations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.

querystring

Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.

sourceCloudLocationstring

Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.

Response

Successful response

nextPageTokenstring

Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.

Changes

No recorded changes to this operation across all 4 revisions of this API.