Method: projects.sites.customDomains.list

列出与指定父托管站点关联的每个CustomDomain

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

HTTP请求

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

URL 使用gRPC 转码语法。

路径参数

参数
parent

string

必需的。包含您想要列出的CustomDomain实体的 Firebase 托管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

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