Method: projects.sites.customDomains.list

Enumera cada CustomDomain asociado con el sitio de Hosting superior especificado.

Muestra CustomDomain en un orden coherente, pero indefinido para facilitar la paginación.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. El Site de Firebase Hosting con las entidades CustomDomain que quieres enumerar.

Parámetros de consulta

Parámetros
pageSize

integer

La cantidad máxima de entidades CustomDomain que se mostrarán en una solicitud. La configuración predeterminada es 10.

pageToken

string

Un token de una llamada anterior a customDomains.list que le indica al servidor dónde reanudar la lista.

showDeleted

boolean

Si es verdadero, la solicitud muestra CustomDomains que se borraron de forma no definitiva que aún no se borraron por completo. Para restablecer CustomDomains borrados, realiza una solicitud customDomains.undelete.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta de customDomains.list.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
Campos
customDomains[]

object (CustomDomain)

Una lista de entidades de CustomDomain asociadas con el Site de Firebase especificado.

nextPageToken

string

El token de paginación, si existen más resultados además de los que aparecen en esta respuesta.

Incluye este token en tu próxima llamada a customDomains.list. Los tokens de página son de corta duración y no se deben almacenar.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta Descripción general de la autenticación.