列出指定项目(包括 FirebaseProject
)的有效 Google Cloud Platform (GCP) 资源位置。
您可以选择这些位置之一作为项目的默认 GCP 资源位置,即默认情况下将预配项目资源(如 Cloud Firestore)的地理位置。不过,如果已为项目设置默认 GCP 资源位置,则无法更改此设置。
此调用会检查指定项目是否存在任何可能的位置限制,并因此返回所有可能的 GCP 资源位置中的一部分。如需列出所有 GCP 资源位置(无论是否存在任何限制),请调用端点而不指定唯一项目标识符(即 /v1beta1/{parent=projects/-}/listAvailableLocations
)。
如需使用指定项目调用 availableLocations.list
,成员必须至少是项目的 Viewer。未指定项目的调用不需要任何特定的项目权限。
HTTP 请求
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
要为其列出 GCP 资源位置的
请参阅 如果未指定唯一项目标识符(即 |
查询参数
参数 | |
---|---|
pageToken |
之前调用 |
pageSize |
响应中可返回的营业地点数量上限。 服务器可以自行决定返回少于此值的项目。如果未指定任何值(或指定的值太大),则服务器将强制执行其自己的限值。 该值不能为负数。 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"locations": [
{
object ( |
字段 | |
---|---|
locations[] |
调用 |
nextPageToken |
如果结果列表太大而无法容纳单个响应,则返回令牌。如果字符串为空,则此响应是结果的最后一页,并且所有可用的地理位置均已列出。 此令牌可用于后续调用 页面令牌只在短时间内有效,不应持久保留。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
https://www.googleapis.com/auth/firebase
https://www.googleapis.com/auth/firebase.readonly
如需了解详情,请参阅身份验证概览。
位置
可为 FirebaseProject
选择的 GCP 资源位置。
JSON 表示法 |
---|
{ "locationId": string, "type": enum ( |
字段 | |
---|---|
locationId |
GCP 资源位置的 ID。它将是可用的 GCP 资源位置之一。 |
type |
指示 GCP 资源位置是用于数据复制的单区域位置还是多区域位置。 |
features[] |
GCP 资源位置提供的产品和服务。 |
LocationType
指定在 GCP 资源位置中复制数据的方式。详细了解 GCP 资源位置的类型。
枚举 | |
---|---|
LOCATION_TYPE_UNSPECIFIED |
仅供内部使用,用于区分未设置的值,不适合外部使用。 |
REGIONAL |
该位置为单区域位置。 单区域位置中的数据会复制到一个区域内的多个可用区。 |
MULTI_REGIONAL |
该位置是一个多区域位置。 多区域位置中的数据会复制到多个区域。在每个区域内,数据会复制到多个可用区。 |
LocationFeature
GCP 资源位置提供的产品和服务。
枚举 | |
---|---|
LOCATION_FEATURE_UNSPECIFIED |
仅供内部使用,用于区分未设置的值,不适合外部使用。 |
FIRESTORE |
此位置支持 Cloud Firestore 数据库实例。 App Engine 在此位置可用,因此可以是项目的默认 GCP 资源位置。 |
DEFAULT_STORAGE |
此位置支持默认的 Cloud Storage 存储分区。 App Engine 在此位置可用,因此可以是项目的默认 GCP 资源位置。 |
FUNCTIONS |
Cloud Functions for Firebase 可在此位置使用。 |