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

有關詳細信息，請參閱身份驗證概述。