列出指定项目(包括FirebaseProject
)的有效 Google Cloud Platform (GCP) 资源位置。
可以选择这些位置之一作为项目的默认GCP 资源位置,这是默认配置项目资源(例如 Cloud Firestore)的地理位置。但是,如果已为项目设置默认 GCP 资源位置,则无法更改此设置。
此调用检查指定项目的任何可能的位置限制,因此可能返回所有可能的 GCP 资源位置的子集。要列出所有 GCP 资源位置(无论有任何限制),请调用端点而不指定唯一项目标识符(即/v1beta1/{parent=projects/-}/listAvailableLocations
)。
要调用指定项目的availableLocations.list
,成员必须至少是项目的查看者。没有指定项目的调用不需要任何特定的项目权限。
HTTP请求
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
parent | 要列出 GCP 资源位置的 有关PROJECT_IDENTIFIER值的详细信息,请参阅 如果未指定唯一的项目标识符(即, |
查询参数
参数 | |
---|---|
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 资源位置中提供的产品和服务。 |
位置类型
指定如何在 GCP 资源位置内复制数据。详细了解GCP 资源位置的类型。
枚举 | |
---|---|
LOCATION_TYPE_UNSPECIFIED | 在内部用于区分未设置的值,不适合外部使用。 |
REGIONAL | 该位置是区域位置。 区域位置中的数据会复制到区域内的多个区域中。 |
MULTI_REGIONAL | 该位置是一个多区域位置。 多区域位置中的数据会复制到多个区域中。在每个区域内,数据被复制到多个区域中。 |
位置特征
GCP 资源位置中提供的产品和服务。
枚举 | |
---|---|
LOCATION_FEATURE_UNSPECIFIED | 在内部用于区分未设置的值,不适合外部使用。 |
FIRESTORE | 此位置支持 Cloud Firestore 数据库实例。 App Engine 在此位置可用,因此它可以是项目的默认 GCP 资源位置。 |
DEFAULT_STORAGE | 此位置支持默认 Cloud Storage 存储桶。 App Engine 在此位置可用,因此它可以是项目的默认 GCP 资源位置。 |
FUNCTIONS | Cloud Functions for Firebase 在此位置可用。 |