---
title: "GET /v1/projects/{projectsId}/locations/{locationsId}/cloudLocations:search"
method: GET
path: "/v1/projects/{projectsId}/locations/{locationsId}/cloudLocations:search"
tags: ["projects"]
---

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

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

## 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`

Searches for cloud locations from a given source location.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required

## Query parameters

- `pageSize` integer
- `pageToken` string
- `query` string
- `sourceCloudLocation` string

## Response `200`

Successful response

- SearchCloudLocationsResponse: Message for response to searching cloud locations.
  - `cloudLocations` CloudLocation[]: Output only. List of cloud locations.
    - `carbonFreeEnergyPercentage` number, float: Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
    - `cloudLocationType` 'CLOUD_LOCATION_TYPE_UNSPECIFIED' | 'CLOUD_LOCATION_TYPE_REGION' | 'CLOUD_LOCATION_TYPE_ZONE' | 'CLOUD_LOCATION_TYPE_GDCC_ZONE' | 'CLOUD_LOCATION_TYPE_GLOBAL': Optional. The type of the cloud location.
    - `cloudProvider` 'CLOUD_PROVIDER_UNSPECIFIED' | 'CLOUD_PROVIDER_GCP' | 'CLOUD_PROVIDER_AWS' | 'CLOUD_PROVIDER_AZURE' | 'CLOUD_PROVIDER_OCI': Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
    - `containingCloudLocation` string: Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
    - `displayName` string: Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
    - `gcpAttributes` GcpAttributes: GCP-specific attributes.
      - `zoneType` 'GCP_ZONE_TYPE_UNSPECIFIED' | 'GENERAL_PURPOSE' | 'AI_ZONE': Optional. The type of the cloud zone.
    - `name` string: Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
    - `territoryCode` string: Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
  - `nextPageToken` string: 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.

---

[API](https://skmtc.dev/google/apis/cloudlocationfinder.md) - [All operations](https://skmtc.dev/google/apis/cloudlocationfinder/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/cloudlocationfinder/revisions/faaf90ffca84?raw)