Method: projects.sites.customDomains.list

Listet alle CustomDomain auf, die mit der angegebenen übergeordneten Hosting-Site verknüpft sind.

Gibt CustomDomain s in einer konsistenten, aber undefinierten Reihenfolge zurück, um die Paginierung zu erleichtern.

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcoding -Syntax.

Pfadparameter

Parameter
parent

string

Erforderlich. Die Firebase-Hosting- Site mit CustomDomain Entitäten, die Sie auflisten möchten.

Abfrageparameter

Parameter
pageSize

integer

Die maximale Anzahl von CustomDomain Entitäten, die in einer Anfrage zurückgegeben werden sollen. Der Standardwert ist 10.

pageToken

string

Ein Token aus einem vorherigen Aufruf von customDomains.list , der dem Server mitteilt, wo die Auflistung fortgesetzt werden soll.

showDeleted

boolean

Bei „true“ gibt die Anfrage vorläufig gelöschte CustomDomain s zurück, die noch nicht vollständig gelöscht wurden. Um gelöschte CustomDomain s wiederherzustellen, stellen Sie eine customDomains.undelete -Anfrage.

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

Die Antwort von customDomains.list .

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
Felder
customDomains[]

object ( CustomDomain )

Eine Liste von CustomDomain Entitäten, die der angegebenen Firebase- Site zugeordnet sind.

nextPageToken

string

Das Paginierungstoken, wenn über die Ergebnisse in dieser Antwort hinaus weitere Ergebnisse vorhanden sind.

Fügen Sie dieses Token in Ihren nächsten Aufruf von customDomains.list ein. Seitentokens sind von kurzer Dauer und sollten nicht gespeichert werden.

Berechtigungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .