Method: projects.availableLocations.list

지정된 프로젝트( 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

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 리소스 위치에서 사용할 수 있는 제품 및 서비스입니다.

위치 유형

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