Method: projects.sites.customDomains.list

列出与指定的父级 Hosting 网站关联的每个 CustomDomain。

以一致但未定义的顺序返回 CustomDomain，以便于分页。

HTTP 请求

GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。Firebase Hosting 包含您要列出的 CustomDomain 个实体的 Site。

查询参数

参数
pageSize

integer

一个请求中要返回的 CustomDomain 实体的数量上限。默认值为 10。
pageToken

string

上一次调用 customDomains.list 得到的令牌，告知服务器在哪里恢复列表。
showDeleted

boolean

如果为 true，请求会返回尚未完全删除的软删除 CustomDomain。如需恢复已删除的 CustomDomain，请发出 customDomains.undelete 请求。

请求正文

请求正文必须为空。

响应正文

来自 customDomains.list 的响应。

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

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

object (CustomDomain)

与指定的 Firebase Site 相关联的 CustomDomain 实体的列表。
nextPageToken

string

除了此响应中的结果之外，还有更多结果存在时提供分页令牌。

在下次调用 customDomains.list 时添加此令牌。页面令牌在短期内有效，不应进行存储。

授权范围

需要以下 OAuth 范围之一：

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

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