Method: projects.locations.instances.list

Liệt kê từng DatabaseInstance được liên kết với dự án mẹ đã chỉ định.

Các mục trong danh sách được trả về không theo thứ tự cụ thể, nhưng sẽ là khung hiển thị nhất quán của các thực thể cơ sở dữ liệu khi bạn gửi thêm yêu cầu bằng pageToken.

Danh sách thu được chứa các thực thể trong STATE bất kỳ.

Kết quả danh sách có thể cũ sau vài giây.

Sử dụng instances.get để có kết quả đọc nhất quán.

yêu cầu HTTP

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

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

Tham số đường dẫn

Thông số
parent

string

Dự án mẹ liệt kê các thực thể cơ sở dữ liệu, có dạng: projects/{project-number}/locations/{location-id}

Để liệt kê trên tất cả các vị trí, hãy sử dụng cấp độ gốc trong biểu mẫu: projects/{project-number}/locations/-

Việc uỷ quyền đòi hỏi quyền IAM sau đây đối với tài nguyên được chỉ định parent:

  • firebasedatabase.instances.list

Tham số truy vấn

Thông số
pageToken

string

Mã thông báo được trả về từ lệnh gọi instances.list trước đó cho biết vị trí cần tiếp tục liệt kê trong tập hợp các thực thể cơ sở dữ liệu.
pageSize

integer

Số lượng thực thể cơ sở dữ liệu 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 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.
showDeleted

boolean

Cho biết rằng DatabaseInstance ở trạng thái DELETED cũng cần được trả về.

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:

Phản hồi từ phương thức instances.list.

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

object (DatabaseInstance)

Danh sách mỗi DatabaseInstance trong dự án Firebase chính.
nextPageToken

string

Nếu danh sách kết quả quá lớn nên không thể chứa hết 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.

Bạn có thể dùng mã thông báo này trong lệnh gọi tiếp theo tới instances.list để tìm nhóm thực thể cơ sở dữ liệu tiếp theo.

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.