Method: projects.sites.customDomains.list

Zawiera listę wszystkich elementów CustomDomain powiązanych z określoną nadrzędną witryną Hostingu.

Zwraca elementy CustomDomain w spójnej, ale niezdefiniowanej kolejności, aby ułatwić podział na strony.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Hosting Firebase Site z CustomDomain elementami, które chcesz wyświetlić.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba elementów (CustomDomain) do zwrócenia w żądaniu. Domyślna wartość to 10.
pageToken

string

Token z poprzedniego wywołania customDomains.list informujący serwer, gdzie wznowić wyświetlanie listy.
showDeleted

boolean

Jeśli ma wartość true (prawda), żądanie zwraca przeniesione do kosza reguły CustomDomain, które nie zostały jeszcze w pełni usunięte. Aby przywrócić usunięte CustomDomain elementy, wyślij prośbę o: customDomains.undelete.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź od użytkownika customDomains.list.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
Pola
customDomains[]

object (CustomDomain)

Lista CustomDomain elementów powiązanych z konkretnym elementem Firebase Site.
nextPageToken

string

Token podziału na strony, jeśli oprócz wyników w tej odpowiedzi jest więcej wyników.

Umieść ten token w następnym wywołaniu funkcji customDomains.list. Tokeny stron mają krótki okres ważności i nie należy ich przechowywać.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).