Method: projects.sites.customDomains.list

Lista cada CustomDomain associado ao site pai especificado do Hosting.

Retorna CustomDomains em uma ordem consistente, mas indefinida, para facilitar a paginação.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O Site do Firebase Hosting com CustomDomain entidades que você quer listar.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de entidades CustomDomain a serem retornadas em uma solicitação. O valor padrão é 10.
pageToken

string

Um token de uma chamada anterior para customDomains.list que informa ao servidor onde retomar a listagem.
showDeleted

boolean

Se for verdadeiro, a solicitação retornará CustomDomains excluídos de forma reversível que ainda não foram totalmente excluídos. Para restaurar CustomDomains excluídos, faça uma solicitação customDomains.undelete.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta de customDomains.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
Campos
customDomains[]

object (CustomDomain)

Uma lista de entidades CustomDomain associadas ao Site especificado do Firebase.
nextPageToken

string

O token de paginação, se houver mais resultados além daqueles nesta resposta.

Inclua esse token na próxima chamada para customDomains.list. Os tokens de página são de curta duração e não devem ser armazenados.

Escopos de autorização

Requer um dos seguintes escopos 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 saber mais, consulte a Visão geral da autenticação.