REST Resource: projects.locations.backends.domains

Recurso: Domain

Un nombre de dominio que está asociado con un backend.

Representación 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. El nombre del recurso del dominio, p.ej., /projects/p/locations/l/backends/b/domains/foo.com

displayName

string

Opcional. Es el nombre del dominio mutable y legible. Límite de 63 caracteres. p.ej., prod domain

createTime

string (Timestamp format)

Solo salida. Hora en la que se creó el dominio.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo salida. Hora a la que se actualizó el dominio por última vez.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

type

enum (Type)

Solo salida. Es el tipo de dominio.

disabled

boolean

Opcional. Indica si el dominio está inhabilitado. La configuración predeterminada es "false".

serve

object (ServingBehavior)

Opcional. El comportamiento de entrega del dominio. Si se especifica, el dominio entregará contenido que no sea el contenido publicado en su backend.

customDomainStatus

object (CustomDomainStatus)

Solo salida. Representa el estado y la configuración de un dominio de tipo CUSTOM. Solo está presente en los dominios de ese tipo.

reconciling

boolean

Solo salida. Un campo que, si es verdadero, indica que la compilación tiene una LRO en curso.

deleteTime

string (Timestamp format)

Solo salida. Hora en la que se borró el dominio.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

purgeTime

string (Timestamp format)

Solo salida. Hora en la que un dominio borrado de forma no definitiva se borrará definitivamente y se procesará de forma permanente.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Opcional. Etiquetas como pares clave-valor.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

Opcional. Las anotaciones como pares clave-valor

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

uid

string

Solo salida. Es un identificador único asignado por el sistema.

etag

string

Solo salida. Suma de verificación procesada por el servidor basada en otros valores se puede enviar cuando se actualice o borre para garantizar que la operación se realice en el recurso esperado.

Tipo

Es el tipo de dominio.

Enums
TYPE_UNSPECIFIED El tipo no se especifica (esto no debería suceder).
DEFAULT Dominios administrados y proporcionados por App Hosting predeterminados. Estos dominios se crean automáticamente con su backend superior y no se pueden borrar, a menos que se borre ese superior, y no se pueden mover a otro backend. Los dominios predeterminados se pueden inhabilitar en el campo disabled.
CUSTOM Dominios personalizados propiedad del desarrollador Los dominios personalizados te permiten asociar un dominio que tengas con tu backend de Hosting de apps y configurar ese dominio para entregar el contenido de tu backend.

Comportamiento de publicación

Indica si App Hosting entregará contenido en el dominio.

Representación 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ón serving_behavior. Si se especifica, personaliza el comportamiento de entrega de un dominio. serving_behavior puede ser solo uno de los siguientes:
redirect

object (Redirect)

Opcional. Comportamiento de redireccionamiento para un dominio, si se proporciona.

Redireccionamiento

Especifica el comportamiento de redireccionamiento de un dominio.

Representación JSON
{
  "uri": string,
  "status": string
}
Campos
uri

string

Obligatorio. Es el URI del destino previsto del redireccionamiento. Este URI se antepondrá a la ruta de la solicitud original. Se supone que los URI sin esquema son HTTPS.

status

string (int64 format)

Opcional. El código de estado que se usará en una respuesta de redireccionamiento. Debe ser un código de estado HTTP 3XX válido. El valor predeterminado es 302 si no está presente.

Estado de dominio personalizado

El estado de la vinculación de un dominio personalizado a un backend.

Representación JSON
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
Campos
hostState

enum (HostState)

Solo salida. Realiza un seguimiento para saber si se detecta que un dominio personalizado dirige el tráfico de forma adecuada a App Hosting.

ownershipState

enum (OwnershipState)

Solo salida. Realiza un seguimiento para saber si el backend puede entregar contenido en el dominio, en función de los registros DNS del dominio.

certState

enum (CertState)

Solo salida. Realiza un seguimiento del estado del certificado SSL del dominio.

requiredDnsUpdates[]

object (DnsUpdates)

Solo salida. Enumera los registros que se deben agregar o quitar al DNS de un dominio personalizado para finalizar la configuración y comenzar a entregar contenido. El campo está presente durante la integración. También está presente después de la integración si uno o más de los estados anteriores no están *_ACTIVE, lo que indica que los registros DNS del dominio están en mal estado.

issues[]

object (Status)

Solo salida. Una lista de problemas con la configuración del dominio. Permite que los usuarios corrijan sus problemas con los registros DNS.

Estado del host

El estado del host de tu dominio. El estado del host se determina verificando cada dirección IP asociada con tu dominio para ver si entrega a través del fragmento apropiado del origen de App Hosting.

Enums
HOST_STATE_UNSPECIFIED El estado del host de tu dominio personalizado no está especificado. El mensaje no es válido si no se especifica.
HOST_UNHOSTED Tu dominio personalizado no está asociado a ninguna dirección IP.
HOST_UNREACHABLE No se puede acceder a tu dominio personalizado. Servicios de hosting de apps Las consultas de DNS para encontrar las direcciones IP de tu dominio generaron errores. Consulta el campo issues de tu CustomDomainStatus para obtener más información.
HOST_NON_FAH Tu dominio solo tiene direcciones IP que, en última instancia, no resuelven a App Hosting.
HOST_CONFLICT Tu dominio tiene direcciones IP que se resuelven tanto para App Hosting como para otros servicios. Para garantizar resultados coherentes, quita los registros A y AAAA relacionados con los servicios que no sean de App Hosting.
HOST_WRONG_SHARD Tu dominio tiene direcciones IP que se resuelven en una región o un fragmento de replicación incorrectos de App Hosting.
HOST_ACTIVE App Hosting entrega todas las solicitudes en tu dominio a través del fragmento asignado de tu dominio. Si el OwnershipState del dominio personalizado también es OWNERSHIP_ACTIVE, App Hosting entrega el contenido de su backend en solicitudes para el dominio.

Estado de propiedad

El estado de propiedad de tu dominio personalizado.

Enums
OWNERSHIP_STATE_UNSPECIFIED El estado de propiedad del dominio personalizado no está especificado. Esto nunca debería suceder.
OWNERSHIP_MISSING El dominio de tu dominio personalizado no tiene registros de propiedad relacionados con App-Hosting. ningún backend está autorizado a entregar en el dominio de este fragmento de origen.
OWNERSHIP_UNREACHABLE No se puede acceder a tu dominio personalizado. Servicios de hosting de apps Las consultas de DNS para encontrar los registros de propiedad de tu dominio generaron errores. Consulta el campo issues de tu CustomDomainStatus para obtener más información.
OWNERSHIP_MISMATCH Tu dominio personalizado es propiedad de otro dominio personalizado de Hosting de apps. Quita los registros en conflicto y reemplázalos por registros de tu dominio personalizado actual.
OWNERSHIP_CONFLICT Tu dominio personalizado tiene registros TXT en conflicto que indican la propiedad de tu dominio personalizado actual, uno o varios otros. Quita los registros de propiedad irrelevantes para otorgar la propiedad actual del dominio personalizado.
OWNERSHIP_PENDING Los registros DNS de tu dominio personalizado están configurados correctamente. App Hosting transferirá la propiedad de tu dominio a este dominio personalizado en un plazo de 24 horas.
OWNERSHIP_ACTIVE Tu dominio personalizado es propietario de su dominio.

Estado de certificación

El estado del certificado SSL que tiene App Hosting para tu nombre de dominio. Puede representar el estado del certificado real o, en el caso de nuevos dominios personalizados, el intento en curso de App Hosting de crear un certificado.

Enums
CERT_STATE_UNSPECIFIED El estado del certificado no está especificado. El mensaje no es válido si no se especifica.
CERT_PREPARING El estado inicial de cada certificado representa la intención de App Hosting de crear un certificado antes de que se realicen solicitudes a una autoridad certificadora.
CERT_VALIDATING Hosting de apps valida si los registros DNS de un nombre de dominio se encuentran en un estado que permite la creación de certificados en su nombre.
CERT_PROPAGATING El certificado se creó recientemente y necesita tiempo para propagarse en los balanceadores de cargas de App Hosting.
CERT_ACTIVE El certificado está activo y proporciona conexiones seguras para los nombres de dominio que representa.
CERT_EXPIRING_SOON El certificado vencerá. Todos los nombres de dominio que contenga recibirán certificados nuevos.
CERT_EXPIRED El certificado venció. Hosting de apps ya no puede entregar contenido seguro en tu nombre de dominio.

Actualizaciones de DNS

Un conjunto de actualizaciones de registros DNS que debes realizar para permitir que App Hosting entregue contenido seguro en respuesta a las solicitudes en tu dominio. Estas actualizaciones presentan el estado actual de tu dominio y los subdominios relacionados Registros DNS cuando App Hosting los consultó por última vez y el conjunto de registros deseado que App Hosting debe ver para que tu dominio personalizado pueda estar completamente activo.

Representación JSON
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
Campos
domainName

string

Solo salida. El nombre de dominio al que pertenecen las actualizaciones de DNS.

discovered[]

object (DnsRecordSet)

Solo salida. El conjunto de registros DNS que Hosting de apps descubrió cuando se inspecciona un dominio.

desired[]

object (DnsRecordSet)

Solo salida. El conjunto de registros DNS que necesita App Hosting para poder entregar contenido seguro en el dominio.

checkTime

string (Timestamp format)

Solo salida. La última vez que App Hosting verificó los registros DNS de tu dominio personalizado.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

DnsRecordSet

Un conjunto de registros DNS relevantes para la configuración y el mantenimiento de un dominio personalizado en App Hosting.

Representación JSON
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
Campos
domainName

string

Solo salida. El nombre de dominio al que pertenece el conjunto de registros.

checkError

object (Status)

Solo salida. Se produjo un error cuando se consultaron los servicios de App Hosting cuando se consultaban los registros DNS de tu dominio. Nota: Hosting de apps ignora los errores NXDOMAIN, ya que, por lo general, significan que todavía no se configuró un nombre de dominio.

records[]

object (DnsRecord)

Solo salida. Registros en el dominio.

DnsRecord

Una representación de los registros DNS de un dominio.

Los registros DNS son registros de recursos que definen el comportamiento de los sistemas y servicios cuando se manejan solicitudes de un dominio. Por ejemplo, cuando agregas registros A a los registros DNS de tu dominio, les estás informando a otros sistemas (como los navegadores web de tus usuarios) que se comuniquen con esas direcciones IPv4 para recuperar recursos relevantes para tu dominio (como tus archivos de Hosting de apps).

Representación JSON
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
Campos
domainName

string

Solo salida. El dominio al que pertenece el registro, p.ej., foo.bar.com.

type

enum (Type)

Solo salida. El tipo de registro, que determina qué datos contiene el registro.

rdata

string

Solo salida. Los datos del registro. El significado del valor depende del tipo de registro: - A y AAAA: direcciones IP para el dominio. - CNAME: otro dominio para buscar registros - TXT: cadenas de texto arbitrarias asociadas con el dominio. App Hosting usa registros TXT para determinar qué proyectos de Firebase tienen permiso para actuar en nombre del dominio. - CAA: las marcas, la etiqueta y el valor del registro, p.ej., 0 issue "pki.goog"

requiredAction

enum (Action)

Solo salida. Una enumeración que indica la acción necesaria para este registro. Se propaga cuando el registro es parte de un cambio obligatorio en un conjunto de registros DnsUpdates discovered o desired.

relevantState[]

enum (CustomDomainState)

Solo salida. Una enumeración que indica a qué estados se aplica este registro DNS. Se propaga para todos los registros con una acción requerida de ADD o REMOVE.

Tipo

El tipo de registro DNS, incluidos A, TXT, AAAA y CAA.

Enums
TYPE_UNSPECIFIED El tipo de registro no está especificado. El mensaje no es válido si no se especifica.
A Un registro A, como se define en RFC 1035 Los registros A determinan a qué direcciones IPv4 dirige el tráfico un dominio.
CNAME Un registro CNAME, como se define en RFC 1035 Los registros CNAME o de nombre canónico asignan un dominio a un dominio canónico diferente. Si hay un registro CNAME presente, debe ser el único registro en el dominio.
TXT Un registro TXT, como se define en RFC 1035 Los registros TXT contienen datos de texto arbitrarios en un dominio. Hosting usa registros TXT a fin de establecer el proyecto de Firebase que tiene permiso para realizar acciones en un dominio.
AAAA Un registro AAAA, como se define en RFC 3596, los registros AAAA determinan a qué direcciones IPv6 dirige el tráfico un dominio.
CAA

Un registro de CAA, como se define en RFC 6844. Los registros de autorización de autoridad certificadora (CAA) determinan qué autoridades certificadoras (organizaciones de creación de certificados SSL) están autorizadas a acuñar un certificado para el dominio. App Hosting usa pki.goog como su AC principal.

Registros de CAA en cascada. Un registro de CAA en foo.com también se aplica a bar.foo.com, a menos que bar.foo.com tenga su propio conjunto de registros de CAA.

Los registros CAA son opcionales. Si un dominio y sus elementos superiores no tienen registros de CAA, todas las CA están autorizadas a acuñar certificados en su nombre. En general, App Hosting solo te pide que modifiques los registros CAA cuando es necesario para desbloquear la creación del certificado SSL.

Acción

El tipo de acción que debes realizar en este registro DNS para configurar tu dominio y usarlo con App Hosting.

Enums
NONE No se requiere ninguna acción.
ADD Agrega este registro a tus registros DNS.
REMOVE Quita este registro de tus registros DNS.

Estado de dominio personalizado

Es un conjunto de estados relevantes para el buen funcionamiento de un dominio personalizado.

Enums
CUSTOM_DOMAIN_STATE_UNSPECIFIED Este mensaje no es válido si no se especifica.
HOST_STATE El estado del host del dominio personalizado.
OWNERSHIP_STATE El estado de propiedad del dominio personalizado.
CERT_STATE El estado del certificado del dominio personalizado.

Métodos

create

Vincula un dominio nuevo a un backend.

delete

Borra un solo dominio.

get

Permite obtener información sobre un dominio.

list

Muestra una lista de los dominios de un backend.

patch

Actualiza la información de un solo dominio.