Method: projects.availableLocations.list

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

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

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

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

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 GCP, theo định dạng:

projects/ PROJECT_IDENTIFIER

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

Nếu không có mã định danh dự án duy nhất nào được chỉ định (nghĩa là projects/- ), thì danh sách được trả về sẽ không tính đến các hạn chế về vị trí dành riêng cho 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ừ cuộc gọi trước tới availableLocations.list cho biết vị trí trong danh sách các vị trí để tiếp tục danh sách.

pageSize

integer

Số lượng vị trí tối đa cần trả về trong phản hồ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 không có giá trị nào được chỉ định (hoặc giá trị quá lớn được chỉ định), thì máy chủ sẽ áp đặt giới hạn của chính nó.

Giá trị này không thể âm.

Nội dung yêu cầu

Phần thân 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 JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Lĩnh vực
locations[]

object ( Location )

Một trang kết quả từ lệnh gọi đến availableLocations.list .

nextPageToken

string

Nếu danh sách kết quả quá lớn để có thể chứa một phản hồi duy nhất thì mã thông báo sẽ được trả về. 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ả các vị trí có sẵn đã được liệt kê.

Mã thông báo này có thể được sử dụng trong lệnh gọi tiếp theo tới 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 tồn tại lâu dài.

Phạm vi ủy 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 Tổng quan về xác thực .

Vị trí

Vị trí tài nguyên GCP có thể được chọn cho FirebaseProject .

Biểu diễn JSON
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
Lĩnh vực
locationId

string

ID của vị trí tài nguyên GCP. Nó sẽ là một trong những vị trí tài nguyên GCP có sẵn.

type

enum ( LocationType )

Cho biết vị trí tài nguyên GCP là vị trí khu vực hay đa 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 ở vị trí tài nguyên GCP.

Loại địa điểm

Chỉ định cách sao chép dữ liệu 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 GCP .

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

Vị trí là một vị trí khu vực.

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

MULTI_REGIONAL

Vị trí là một vị trí đa khu vực.

Dữ liệu ở một vị trí nhiều vùng được sao chép ở nhiều vùng. Trong mỗi vùng, dữ liệu đượ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 ở vị trí tài nguyên GCP.

Enum
LOCATION_FEATURE_UNSPECIFIED Được sử dụng nội bộ để phân biệt các giá trị chưa được đặ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 phiên bản cơ sở dữ liệu Cloud Firestore.

App Engine có sẵn ở vị trí này nê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 nhóm Lưu trữ đám mây mặc định.

App Engine có sẵn ở vị trí này nên nó có thể là vị trí tài nguyên GCP mặc định của Dự án.

FUNCTIONS Chức năng đám mây cho Firebase có sẵn ở vị trí này.