Method: projects.sites.customDomains.list

Répertorie chaque CustomDomain associé au site d'hébergement parent spécifié.

Renvoie CustomDomain dans un ordre cohérent, mais non défini, pour faciliter la pagination.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Requis. Le Site d'hébergement Firebase avec les entités CustomDomain que vous souhaitez répertorier.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximum d'entités CustomDomain à renvoyer dans une requête. La valeur par défaut est 10.

pageToken

string

Jeton d'un appel précédent à customDomains.list qui indique au serveur où reprendre le listing.

showDeleted

boolean

Si c'est vrai, la requête renvoie les CustomDomain supprimés de manière logicielle qui n'ont pas encore été entièrement supprimés. Pour restaurer les CustomDomain supprimés, effectuez une requête customDomains.undelete .

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

La réponse de customDomains.list .

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

Représentation JSON
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
Des champs
customDomains[]

object ( CustomDomain )

Une liste d'entités CustomDomain associées au Firebase Site spécifié.

nextPageToken

string

Le jeton de pagination, s'il existe d'autres résultats que ceux de cette réponse.

Incluez ce jeton dans votre prochain appel à customDomains.list . Les jetons de page sont de courte durée et ne doivent pas être stockés.

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

  • 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

Pour plus d'informations, consultez la Présentation de l'authentification .