Method: projects.databases.collectionGroups.fields.list

Liệt kê cấu hình trường và siêu dữ liệu cho cơ sở dữ liệu này.

Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi FirestoreAdmin.ListFields với bộ lọc được đặt thành indexConfig.usesAncestorConfig:false or ttlConfig:*`.

Yêu cầu HTTP

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

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

Tham số đường dẫn

Thông số
parent

string

Yêu cầu. Tên gốc của biểu projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Tham số truy vấn

Thông số
filter

string

Bộ lọc để áp dụng cho kết quả danh sách. Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi FirestoreAdmin.ListFields bằng bộ lọc bao gồm indexConfig.usesAncestorConfig:false .

pageSize

integer

Số lượng kết quả trả về.

pageToken

string

Mã thông báo trang, được trả về từ lệnh gọi trước tới FirestoreAdmin.ListFields , có thể được sử dụng để lấy trang kết quả tiếp theo.

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

Phản hồi cho FirestoreAdmin.ListFields .

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
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Lĩnh vực
fields[]

object ( Field )

Các trường được yêu cầu.

nextPageToken

string

Mã thông báo trang có thể được sử dụng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

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/datastore
  • https://www.googleapis.com/auth/cloud-platform

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