Method: projects.locations.instances.list

列出与指定父项目关联的每个DatabaseInstance 。

列表项不按特定顺序返回，但当使用pageToken发出其他请求时，将是数据库实例的一致视图。

结果列表包含任何STATE中的实例。

列表结果可能会过时几秒钟。

使用instances.get实现一致的读取。

HTTP请求

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

URL 使用gRPC 转码语法。

路径参数

参数
parent

string

要列出数据库实例的父项目，格式为： projects/{project-number}/locations/{location-id}

要列出所有位置，请使用以下形式的父项： projects/{project-number}/locations/-

授权需要对指定资源parent具有以下IAM权限：

  • firebasedatabase.instances.list

查询参数

参数
pageToken

string

从先前对instances.list的调用返回的令牌，指示要恢复列出的数据库实例集中的位置。

pageSize

integer

响应中返回的数据库实例的最大数量。

服务器可能会自行决定返回少于此数量的数据。如果未指定值（或指定的值太大），则服务器将施加自己的限制。

showDeleted

boolean

指示还应返回处于DELETED状态的 DatabaseInstance。

请求正文

请求正文必须为空。

响应体

如果成功，响应正文包含具有以下结构的数据：

来自instances.list方法的响应。

JSON 表示
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
领域
instances[]

object ( DatabaseInstance )

父 Firebase 项目中的每个DatabaseInstance的列表。

nextPageToken

string

如果结果列表太大而无法容纳单个响应，则返回一个令牌。如果字符串为空，则此响应是结果的最后一页。

该令牌可用于后续调用instances.list来查找下一组数据库实例。

页面令牌是短暂的，不应保留。

授权范围

需要以下 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

有关详细信息，请参阅身份验证概述。