Method: projects.rulesets.list

仅列出 Ruleset 元数据,并且可以选择按 Ruleset 名称过滤结果。

可以使用 rulesets.get 检索 Ruleset 的完整 Source 内容。

HTTP 请求

GET https://firebaserules.googleapis.com/v1/{name=projects/*}/rulesets

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。项目的资源名称。

格式:projects/{project_id}

查询参数

参数
filter

string

Ruleset 过滤条件。list 方法支持对 Ruleset.name 施加限制的过滤条件。

Ruleset.create_time 上的过滤器应使用 date 函数,该函数可解析符合 RFC 3339 日期/时间规范的字符串。

示例:createTime > date("2017-01-01T00:00:00Z") AND name=UUID-*

pageSize

integer

要加载的页面大小。最多 100 个。默认值为 10。注意:pageSize 只是一个提示,服务可能会由于输出大小而选择加载小于 pageSize 的内容。如需遍历所有发布,调用方应进行迭代,直到 pageToken 为空。

pageToken

string

用于加载下一批 Ruleset 实例的下一页令牌。

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

FirebaseRulesService.ListRulesets 的响应。

JSON 表示法
{
  "rulesets": [
    {
      object (Ruleset)
    }
  ],
  "nextPageToken": string
}
字段
rulesets[]

object (Ruleset)

Ruleset 实例的列表。

nextPageToken

string

用于检索下一页结果的分页令牌。如果值为空,系统将不再保留其他结果。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

如需了解详情,请参阅身份验证概览