列出与指定父项目关联的每个DatabaseInstance
。
列表项不按特定顺序返回,但当使用pageToken
发出其他请求时,将是数据库实例的一致视图。
结果列表包含任何STATE
中的实例。
列表结果可能会过时几秒钟。
使用instances.get
实现一致的读取。
HTTP请求
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
parent | 要列出数据库实例的父项目,格式为: 要列出所有位置,请使用以下形式的父项: 授权需要对指定资源
|
查询参数
参数 | |
---|---|
pageToken | 从先前对 |
pageSize | 响应中返回的数据库实例的最大数量。 服务器可能会自行决定返回少于此数量的数据。如果未指定值(或指定的值太大),则服务器将施加自己的限制。 |
showDeleted | 指示还应返回处于 |
请求正文
请求正文必须为空。
响应体
如果成功,响应正文包含具有以下结构的数据:
来自instances.list
方法的响应。
JSON 表示 |
---|
{
"instances": [
{
object ( |
领域 | |
---|---|
instances[] | 父 Firebase 项目中的每个 |
nextPageToken | 如果结果列表太大而无法容纳单个响应,则返回一个令牌。如果字符串为空,则此响应是结果的最后一页。 该令牌可用于后续调用 页面令牌是短暂的,不应保留。 |
授权范围
需要以下 OAuth 范围之一:
-
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
有关详细信息,请参阅身份验证概述。