This page describes the query and filter syntax that Cloud Location Finder uses to return cloud locations based on territory, proximity, and carbon free energy (CFE%) usage. For more information, see the REST API reference.
| Field | Supported operators | Description | Example |
|---|---|---|---|
| carbon_free_energy_percentage | >, < | Matches the carbon free energy percentage as defined by Google. CFE% only supported for Google Cloud locations. |
carbon_free_energy_percentage > 75 |
| cloud_location_type | =, != | Matches a Cloud location type using an enum. | cloud_location_type = CLOUD_LOCATION_TYPE_REGION |
| cloud_provider | =, != | Matches a Cloud provider using an enum. | cloud_provider = CLOUD_PROVIDER_GCP |
| containing_cloud_location | =, != | Matches containing CloudLocation by full resource name. | containing_cloud_location = "projects/clf-e2e-testing/locations/global/cloudLocations/aws-us-east-1" |
| display_name | =, != | Matches a CloudLocation's display_name by full name. | display_name = "us-east-1" |
| latency | >, < | Matches the latency criteria using an integer based on RTT measurements with a unit of ms. This query field applies only when finding the distance between Google Cloud locations and third-party cloud providers. |
latency < 50 |
| territory_code | =, != | Matches a two-letter ISO 3166-1 alpha-2 code | territory_code = "US" |
Example filter
This example filter illustrates the format to use when including a filter in Cloud Location Finder HTTP or Google Cloud CLI queries.
HTTP
filter=cloud_provider=CLOUD_PROVIDER_GCP%20AND%20cloud_location_type=CLOUD_LOCATION_TYPE_ZONE
gcloud
--filter="cloud_provider=CLOUD_PROVIDER_GCP AND cloud_location_type=CLOUD_LOCATION_TYPE_ZONE"