REST Resource: projects.locations.backends.domains

Recurso: Domain

Um nome de domínio associado a um back-end.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "type": enum (Type),
  "disabled": boolean,
  "serve": {
    object (ServingBehavior)
  },
  "customDomainStatus": {
    object (CustomDomainStatus)
  },
  "reconciling": boolean,
  "deleteTime": string,
  "purgeTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
Campos
name

string

Identificador. O nome de recurso do domínio, por exemplo, /projects/p/locations/l/backends/b/domains/foo.com
displayName

string

Opcional. Nome legível e mutável do domínio. Limite de 63 caracteres. Por exemplo: prod domain:
createTime

string (Timestamp format)

Apenas saída. Hora em que o domínio foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. Hora da última atualização do domínio.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
type

enum (Type)

Apenas saída. O tipo de domínio.
disabled

boolean

Opcional. Se o domínio está desativado. O padrão é "false".
serve

object (ServingBehavior)

Opcional. O comportamento de exibição do domínio. Se especificado, o domínio exibirá conteúdo diferente do conteúdo ativo do back-end.
customDomainStatus

object (CustomDomainStatus)

Apenas saída. Representa o estado e a configuração de um domínio do tipo CUSTOM. Ele só está presente em domínios desse tipo.
reconciling

boolean

Apenas saída. Um campo que, se for verdadeiro, indica que o build tem uma LRO em andamento.
deleteTime

string (Timestamp format)

Apenas saída. Hora em que o domínio foi excluído.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
purgeTime

string (Timestamp format)

Apenas saída. Horário em que um domínio excluído de maneira reversível será limpo, com renderização permanente.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Opcional. Rótulos como pares de chave-valor.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Opcional. Anotações como pares de chave-valor.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema.
etag

string

Apenas saída. Soma de verificação calculada pelo servidor com base em outros valores. podem ser enviados na atualização ou exclusão para garantir que a operação seja feita no recurso esperado.

Tipo

O tipo de domínio.

Enums
TYPE_UNSPECIFIED O tipo não foi especificado (isso não deveria acontecer).
DEFAULT Domínios padrão fornecidos e gerenciados pelo App Hosting. Esses domínios são criados automaticamente com o back-end pai e não podem ser excluídos, exceto com a exclusão do pai, e não podem ser movidos para outro back-end. Os domínios padrão podem ser desativados no campo disabled.
CUSTOM Domínios personalizados do desenvolvedor. Os domínios personalizados permitem associar um domínio próprio ao back-end do App Hosting e configurar esse domínio para exibir o conteúdo do back-end.

Comportamento de veiculação

Indica se o App Hosting exibirá conteúdo no domínio.

Representação JSON 
{

  // Union field serving_behavior can be only one of the following:
  "redirect": {
    object (Redirect)
  }
  // End of list of possible types for union field serving_behavior.
}
Campos
Campo de união serving_behavior. Se especificado, personaliza o comportamento de exibição de um domínio. serving_behavior pode ser apenas de um dos tipos a seguir:
redirect

object (Redirect)

Opcional. Redirecione o comportamento de um domínio, se fornecido.

Redirecionamento

Especifica o comportamento de redirecionamento de um domínio.

Representação JSON 
{
  "uri": string,
  "status": string
}
Campos
uri

string

Obrigatório. O URI do destino pretendido do redirecionamento. Esse URI será anexado ao caminho da solicitação original. URI sem um esquema são considerados HTTPS.
status

string (int64 format)

Opcional. O código de status a ser usado em uma resposta de redirecionamento. Precisa ser um código de status HTTP 3XX válido. Se não estiver presente, o padrão será 302.

StatusDoDomínioPersonalizado

O status da vinculação de um domínio personalizado a um back-end.

Representação JSON 
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
Campos
hostState

enum (HostState)

Apenas saída. Monitora se um domínio personalizado é detectado como direcionando adequadamente o tráfego para o App Hosting.
ownershipState

enum (OwnershipState)

Apenas saída. Monitora se o back-end tem permissão para exibir conteúdo no domínio, com base nos registros DNS do domínio.
certState

enum (CertState)

Apenas saída. Monitora o status do certificado SSL do domínio.
requiredDnsUpdates[]

object (DnsUpdates)

Apenas saída. Lista os registros que precisam ser adicionados ou removidos do DNS de um domínio personalizado para concluir a configuração e começar a exibir conteúdo. O campo está presente durante a integração. Também estará presente após a integração se um ou mais dos estados acima não forem *_ACTIVE, indicando que os registros DNS do domínio estão em estado incorreto.
issues[]

object (Status)

Apenas saída. Uma lista de problemas na configuração do domínio. Permite que os usuários corrijam problemas com registros DNS.

Estado do host

O estado do host do seu domínio. O estado do host é determinado pela verificação de cada endereço IP associado ao seu domínio para ver se ele está sendo disponibilizado pelo fragmento apropriado da origem do App Hosting.

Enums
HOST_STATE_UNSPECIFIED O estado do host do seu domínio personalizado não foi especificado. A mensagem será inválida se isso não for especificado.
HOST_UNHOSTED Seu domínio personalizado não está associado a nenhum endereço IP.
HOST_UNREACHABLE Não foi possível acessar seu domínio personalizado. Serviços de hospedagem de apps As consultas DNS para encontrar os endereços IP do seu domínio resultaram em erros. Consulte o campo issues de CustomDomainStatus para mais detalhes.
HOST_NON_FAH Seu domínio tem apenas endereços IP que não são convertidos para a hospedagem de apps.
HOST_CONFLICT Seu domínio tem endereços IP que são resolvidos para o App Hosting e outros serviços. Para garantir resultados consistentes, remova os registros A e AAAA relacionados a serviços que não sejam de hospedagem de app.
HOST_WRONG_SHARD Seu domínio tem endereços IP que são resolvidos para uma região incorreta e/ou fragmento de replicação do App Hosting.
HOST_ACTIVE Todas as solicitações feitas no seu domínio são atendidas pelo App Hosting, por meio do fragmento atribuído ao seu domínio. Se o OwnershipState do domínio personalizado também for OWNERSHIP_ACTIVE, o App Hosting exibirá o conteúdo do back-end nas solicitações do domínio.

PropriedadeEstado

O estado de propriedade do seu domínio personalizado.

Enums
OWNERSHIP_STATE_UNSPECIFIED O estado de propriedade do seu domínio personalizado não foi especificado. Isso nunca deveria acontecer.
OWNERSHIP_MISSING O domínio personalizado não tem registros de propriedade relacionados ao App Hosting. nenhum back-end está autorizado a veicular no domínio neste fragmento de origem.
OWNERSHIP_UNREACHABLE Não foi possível acessar seu domínio personalizado. Serviços de hospedagem de apps Consultas DNS para encontrar os registros de propriedade do seu domínio resultaram em erros. Consulte o campo issues de CustomDomainStatus para mais detalhes.
OWNERSHIP_MISMATCH Seu domínio personalizado pertence a outro domínio personalizado do App Hosting. Remova os registros conflitantes e substitua-os pelos registros do seu domínio personalizado atual.
OWNERSHIP_CONFLICT Seu domínio personalizado tem registros TXT conflitantes que indicam a propriedade do domínio personalizado atual por um ou mais domínios. Remova os registros de propriedade irrelevantes para conceder a propriedade do domínio personalizado atual.
OWNERSHIP_PENDING Os registros DNS do seu domínio personalizado estão configurados corretamente. O App Hosting transferirá a propriedade do seu domínio para esse domínio personalizado em até 24 horas.
OWNERSHIP_ACTIVE O domínio personalizado é o proprietário do próprio domínio.

Certificado

O estado do certificado SSL que o App Hosting tem para seu nome de domínio. Isso pode representar o estado do certificado real ou, para novos domínios personalizados, a tentativa de criação de um certificado do App Hosting.

Enums
CERT_STATE_UNSPECIFIED O estado do certificado não foi especificado. A mensagem será inválida se isso não for especificado.
CERT_PREPARING O estado inicial de cada certificado representa a intenção do App Hosting de criar um certificado antes que as solicitações a uma autoridade de certificação sejam feitas.
CERT_VALIDATING O App Hosting está validando se os registros DNS de um nome de domínio estão em um estado que permite a criação de certificados.
CERT_PROPAGATING O certificado foi criado recentemente e precisa de tempo para ser propagado nos balanceadores de carga do App Hosting.
CERT_ACTIVE O certificado está ativo, fornecendo conexões seguras para os nomes de domínio que representa.
CERT_EXPIRING_SOON O certificado vai expirar. Todos os nomes de domínio nele vão receber novos certificados.
CERT_EXPIRED O certificado expirou. O App Hosting não pode mais exibir conteúdo seguro no seu nome de domínio.

Atualizações do DNS

Um conjunto de atualizações de registros DNS que você deve fazer para permitir que o App Hosting disponibilize conteúdo seguro em resposta a solicitações no seu domínio. Essas atualizações apresentam o estado atual do seu domínio e dos subdomínios relacionados. Registram o momento em que o App Hosting fez consultas pela última vez e o conjunto de registros que o App Hosting precisa ver para que o domínio personalizado seja totalmente ativado.

Representação JSON 
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
Campos
domainName

string

Apenas saída. O nome de domínio ao qual as atualizações de DNS pertencem.
discovered[]

object (DnsRecordSet)

Apenas saída. O conjunto de registros DNS do App Hosting descoberto durante a inspeção de um domínio.
desired[]

object (DnsRecordSet)

Apenas saída. O conjunto de registros DNS precisa que a hospedagem de apps possa fornecer conteúdo seguro no domínio.
checkTime

string (Timestamp format)

Apenas saída. A última vez que o App Hosting verificou os registros DNS do seu domínio personalizado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

DnsRecordSet

Um conjunto de registros DNS relevantes para a configuração e manutenção de um domínio personalizado no App Hosting.

Representação JSON 
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
Campos
domainName

string

Apenas saída. O nome de domínio a que o conjunto de registros pertence.
checkError

object (Status)

Apenas saída. Um erro nos serviços do App Hosting foi encontrado ao consultar os registros DNS do seu domínio. Observação: o App Hosting ignora erros NXDOMAIN, porque eles geralmente significam apenas que um nome de domínio ainda não foi configurado.
records[]

object (DnsRecord)

Apenas saída. Registros no domínio.

Registro Dns

Uma representação dos registros DNS de um domínio.

Os registros DNS são registros de recursos que definem como os sistemas e serviços devem se comportar ao processar solicitações para um domínio. Por exemplo, ao adicionar registros A aos registros DNS do domínio, você instrui outros sistemas (como os navegadores da Web dos usuários) a entrar em contato com esses endereços IPv4 para recuperar recursos relevantes ao domínio, como os arquivos do App Hosting.

Representação JSON 
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
Campos
domainName

string

Apenas saída. O domínio a que o registro pertence, por exemplo, foo.bar.com.:
type

enum (Type)

Apenas saída. O tipo de registro, que determina quais dados o registro contém.
rdata

string

Apenas saída. Os dados do registro. O significado do valor depende do tipo de registro: - A e AAAA: endereços IP para o domínio. - CNAME: outro domínio para verificar os registros. - TXT: strings de texto arbitrárias associadas ao domínio. O App Hosting usa registros TXT para determinar quais projetos do Firebase têm permissão para agir em nome do domínio. - CAA: as sinalizações, a tag e o valor do registro, por exemplo, 0 issue "pki.goog":
requiredAction

enum (Action)

Apenas saída. Um enum que indica uma ação necessária para este registro. Preenchido quando o registro faz parte de uma mudança necessária em um conjunto de registros DnsUpdates discovered ou desired.
relevantState[]

enum (CustomDomainState)

Apenas saída. Um enum que indica a quais estados este registro DNS se aplica. Preenchido em todos os registros com uma ação necessária ADD ou REMOVE.

Tipo

O tipo do registro DNS, incluindo A, TXT, AAAA e CAA.

Enums
TYPE_UNSPECIFIED O tipo do registro não foi especificado. A mensagem será inválida se isso não for especificado.
A Um registro A, conforme definido na RFC 1035 (em inglês). Os registros A determinam para quais endereços IPv4 um domínio direciona o tráfego.
CNAME Um registro CNAME, conforme definido na RFC 1035 (em inglês). Os registros CNAME ou de nome canônico mapeiam um domínio para outro canônico. Se houver um registro CNAME, ele deverá ser o único registro no domínio.
TXT Um registro TXT, conforme definido na RFC 1035 (em inglês). Os registros TXT armazenam dados de texto arbitrários em um domínio. O Hosting usa registros TXT para estabelecer qual projeto do Firebase tem permissão para agir em um domínio.
AAAA Um registro AAAA, conforme definido nos registros AAAA RFC 3596, determina para quais endereços IPv6 um domínio direciona o tráfego.
CAA

Um registro CAA, conforme definido na RFC 6844 (link em inglês). Os registros CAA, ou Autorização de autoridade de certificação, determinam quais autoridades certificadoras (organizações de construção de certificados SSL) estão autorizadas a produzir um certificado para o domínio. O App Hosting usa pki.goog como a CA principal.

Os registros CAA são em cascata. Um registro CAA em foo.com também se aplica a bar.foo.com, a menos que bar.foo.com tenha seu próprio conjunto de registros CAA.

Os registros CAA são opcionais. Se um domínio e os pais dele não tiverem registros CAA, todas as CAs estarão autorizadas a culinar certificados em nome dele. Em geral, o App Hosting só pede que você modifique os registros CAA quando isso é necessário para desbloquear a criação de certificados SSL.

Ação

O tipo de ação que você deve realizar nesse registro DNS para configurar seu domínio para uso com o App Hosting.

Enums
NONE Nenhuma ação é necessária.
ADD Adicione esse registro aos seus registros DNS.
REMOVE Remova esse registro dos seus registros DNS.

EstadoDoDomínioDoPersonalizado

Um conjunto de estados relevantes para o funcionamento íntegro de um domínio personalizado.

Enums
CUSTOM_DOMAIN_STATE_UNSPECIFIED A mensagem será inválida se isso não for especificado.
HOST_STATE O estado do host do domínio personalizado.
OWNERSHIP_STATE O estado de propriedade do domínio personalizado.
CERT_STATE O estado do certificado do domínio personalizado.

Métodos

create

 Vincula um novo domínio a um back-end.

delete

 Exclui um único domínio.

get

 Recebe informações sobre um domínio.

list

 Lista os domínios de um back-end.

patch

 Atualiza as informações de um único domínio.