Method: projects.availableLocations.list

지정된 프로젝트의 유효한 Google Cloud Platform (GCP) 리소스 위치 (FirebaseProject 포함)를 나열합니다.

이러한 위치 중 하나를 프로젝트의 기본 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

string

GCP 리소스 위치를 나열할 FirebaseProject로, 형식은 다음과 같습니다.

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER 값에 대한 자세한 내용은 FirebaseProject name 필드를 참조하세요.

고유한 프로젝트 식별자가 지정되지 않으면 (즉, projects/-) 반환된 목록은 조직별 또는 프로젝트별 위치 제한을 고려하지 않습니다.

쿼리 매개변수

매개변수
pageToken

string

위치 목록에서 등록정보를 재개할 위치를 나타내는 availableLocations.list에 대한 이전 호출에서 반환된 토큰입니다.
pageSize

integer

응답에서 반환할 위치의 최대 개수입니다.

서버는 자체 재량에 따라 이보다 더 적은 수의 앱을 반환할 수 있습니다. 값을 지정하지 않을 경우(또는 너무 큰 값을 지정할 경우), 서버는 자체 한도를 적용합니다.

이 값은 음수일 수 없습니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
필드
locations[]

object (Location)

availableLocations.list 호출 결과의 한 페이지입니다.
nextPageToken

string

결과 목록이 너무 많아서 단일 응답에 맞지 않으면 토큰이 반환됩니다. 문자열이 비어 있는 경우 이 응답은 결과의 마지막 페이지이며 사용 가능한 모든 위치가 나열됩니다.

이 토큰은 후속 availableLocations.list 호출에서 더 많은 위치를 찾는 데 사용할 수 있습니다.

페이지 토큰은 수명이 짧기 때문에 유지해서는 안 됩니다.

승인 범위

다음 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 (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
필드
locationId

string

GCP 리소스 위치의 ID입니다. 사용 가능한 GCP 리소스 위치 중 하나입니다.
type

enum (LocationType)

GCP 리소스 위치가 데이터 복제를 위한 리전 또는 멀티 리전 위치인지 여부를 나타냅니다.
features[]

enum (LocationFeature)

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 이 위치에서 Firebase용 Cloud Functions를 사용할 수 있습니다.