Method: projects.availableLocations.list

Liệt kê các vị trí tài nguyên hợp lệ của Google Cloud Platform (GCP) cho Dự án đã chỉ định (bao gồm cả FirebaseProject).

Bạn có thể chọn một trong những vị trí này làm vị trí tài nguyên GCP mặc định của Dự án. Đây là vị trí địa lý nơi các tài nguyên của Dự án (chẳng hạn như Cloud Firestore) sẽ được cấp phép theo mặc định. Tuy nhiên, nếu đã đặt vị trí tài nguyên GCP mặc định cho Dự án thì bạn không thể thay đổi chế độ cài đặt này.

Lệnh gọi này sẽ kiểm tra mọi quy định hạn chế về vị trí có thể xảy ra đối với Dự án được chỉ định, do đó, có thể trả về một số vị trí tài nguyên GCP có thể có. Để liệt kê tất cả vị trí tài nguyên GCP (bất kể có quy định hạn chế nào), hãy gọi điểm cuối mà không chỉ định giá trị nhận dạng duy nhất của dự án (tức là /v1beta1/{parent=projects/-}/listAvailableLocations).

Để gọi availableLocations.list bằng một dự án đã chỉ định, tối thiểu một thành viên phải là Người xem của dự án đó. Các lệnh gọi không có dự án được chỉ định không yêu cầu bất kỳ quyền cụ thể nào cho dự án.

yêu cầu HTTP

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

FirebaseProject để liệt kê các vị trí tài nguyên trên Google Cloud Platform (GCP) ở định dạng:

projects/PROJECT_IDENTIFIER

Tham khảo trường FirebaseProject name để biết thông tin chi tiết về các giá trị PROJECT_IDENTIFIER.

Nếu bạn chưa chỉ định giá trị nhận dạng duy nhất của dự án (tức là projects/-), thì danh sách trả về sẽ không tính đến các quy định hạn chế về vị trí theo tổ chức hoặc dự án cụ thể.

Tham số truy vấn

Thông số
pageToken

string

Mã thông báo được trả về từ lệnh gọi trước đó đến availableLocations.list cho biết vị trí cần tiếp tục liệt kê trong danh sách.
pageSize

integer

Số lượng vị trí tối đa cần trả về trong câu trả lời.

Máy chủ có thể trả về ít hơn giá trị này theo quyết định riêng của mình. Nếu bạn không chỉ định giá trị nào (hoặc chỉ định giá trị quá lớn), thì máy chủ sẽ áp dụng giới hạn riêng.

Giá trị này không được là số âm.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Trường
locations[]

object (Location)

Một trang kết quả từ cuộc gọi đến availableLocations.list.
nextPageToken

string

Nếu danh sách kết quả quá lớn nên không thể chứa hết trong một phản hồi, thì hệ thống sẽ trả về một mã thông báo. Nếu chuỗi trống thì phản hồi này là trang kết quả cuối cùng và tất cả vị trí có sẵn đã được liệt kê.

Bạn có thể dùng mã thông báo này trong lệnh gọi tiếp theo đến availableLocations.list để tìm thêm vị trí.

Mã thông báo trang chỉ tồn tại trong thời gian ngắn và không nên duy trì.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc xác thực.

Vị trí

Bạn có thể chọn vị trí tài nguyên GCP cho FirebaseProject.

Biểu diễn dưới dạng JSON 
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Trường
locationId

string

Mã của vị trí tài nguyên trên GCP. Tài nguyên này sẽ là một trong các vị trí tài nguyên GCP hiện có.
type

enum (LocationType)

Cho biết liệu vị trí tài nguyên GCP là một vị trí theo khu vực hay nhiều khu vực để sao chép dữ liệu.
features[]

enum (LocationFeature)

Các sản phẩm và dịch vụ có sẵn tại vị trí tài nguyên GCP.

LocationType

Chỉ định cách dữ liệu được sao chép trong vị trí tài nguyên GCP. Tìm hiểu thêm về các loại vị trí tài nguyên trên GCP.

Enum
LOCATION_TYPE_UNSPECIFIED Dùng nội bộ để phân biệt các giá trị chưa đặt và không nhằm mục đích sử dụng bên ngoài.
REGIONAL

Vị trí là một vị trí theo vùng.

Dữ liệu ở một vị trí theo khu vực được sao chép ở nhiều vùng trong một khu vực.
MULTI_REGIONAL

Vị trí của bạn là một vị trí nhiều khu vực.

Dữ liệu ở một vị trí đa vùng được sao chép ở nhiều khu vực. Trong mỗi khu vực, dữ liệu sẽ được sao chép ở nhiều vùng.

Tính năng vị trí

Các sản phẩm và dịch vụ có sẵn tại vị trí tài nguyên GCP.

Enum
LOCATION_FEATURE_UNSPECIFIED Dùng nội bộ để phân biệt các giá trị chưa đặt và không nhằm mục đích sử dụng bên ngoài.
FIRESTORE

Vị trí này hỗ trợ các thực thể cơ sở dữ liệu Cloud Firestore.

App Engine hoạt động được tại vị trí này nên có thể là vị trí tài nguyên GCP mặc định của Dự án.
DEFAULT_STORAGE

Vị trí này hỗ trợ các bộ chứa mặc định trong Cloud Storage.

App Engine hoạt động được tại vị trí này nên có thể là vị trí tài nguyên GCP mặc định của Dự án.
FUNCTIONS Cloud Functions cho Firebase hiện có ở vị trí này.