列出文档。
HTTP请求
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
parent | 必需的。父资源名称。格式为: 例如: |
collectionId | 选修的。要列出的集合 ID,相对于 例如: 这是可选的,如果未提供,Firestore 将列出所提供的 |
查询参数
参数 | |
---|---|
pageSize | 选修的。单个响应中返回的最大文档数。 Firestore 返回的值可能会少于此值。 |
pageToken | 选修的。从先前的 提供此信息以检索后续页面。分页时,所有其他参数( |
orderBy | 选修的。要返回的文档的可选排序。 例如: 这反映了 Firestore 查询中使用的 |
mask | 选修的。要返回的字段。如果未设置,则返回所有字段。 如果文档具有此掩码中不存在的字段,则该字段将不会在响应中返回。 |
showMissing | 如果列表应显示缺少的文档。 如果文档不存在,则该文档缺失,但其下面嵌套有子文档。如果为 true,则此类丢失的文档将带有键返回,但不会设置字段、 带有 |
联合参数consistency_selector 。此事务的一致性模式。如果不设置,默认为强一致性。 consistency_selector 只能是以下之一: | |
transaction | 将读取作为已活动事务的一部分执行。 Base64 编码的字符串。 |
readTime | 在规定的时间执行读取。 这必须是过去一小时内的微秒精度时间戳,或者如果启用了时间点恢复,则还可以是过去 7 天内的整分钟时间戳。 RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: |
请求正文
请求正文必须为空。
响应体
如果成功,响应正文将包含ListDocumentsResponse
的实例。
授权范围
需要以下 OAuth 范围之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有关详细信息,请参阅身份验证概述。