Method: projects.locations.instances.list

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

Các mục trong danh sách được trả về không theo thứ tự cụ thể nhưng sẽ là chế độ xem nhất quán của các phiên bản cơ sở dữ liệu khi các yêu cầu bổ sung được thực hiện bằng pageToken .

Danh sách kết quả chứa các phiên bản ở bất kỳ STATE nào.

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

Sử dụng instances.get để có số lần đọ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 phiên bản cơ sở dữ liệu, ở 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 ở dạng: projects/{project-number}/locations/-

Việc ủy ​​quyền yêu cầu quyền IAM sau đối với parent tài nguyên gốc được chỉ định:

  • 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 trước tới instances.list cho biết vị trí trong tập hợp các phiên bản cơ sở dữ liệu sẽ tiếp tục liệt kê.

pageSize

integer

Số lượng phiên bản 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 mức này theo quyết định 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ó.

showDeleted

boolean

Cho biết rằng các Phiên bản cơ sở dữ liệu ở trạng thái DELETED cũng phải được trả về.

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:

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

Biểu diễn JSON
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Lĩnh vực
instances[]

object ( DatabaseInstance )

Danh sách từng DatabaseInstance có trong dự án Firebase gốc.

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.

Mã thông báo này có thể được sử dụng trong lệnh gọi tiếp theo tới instances.list để tìm nhóm phiên bản 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 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 .