Method: projects.sites.customDomains.list

列出與指定父項託管網站相關聯的每個 CustomDomain

以一致但未定義的方式傳回 CustomDomain,以便進行分頁。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

執行個體類型,這個 Firebase 託管了 Site,其中包含您要列出的 CustomDomain 個實體。

查詢參數

參數
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

詳情請參閱驗證總覽一文。