REST Resource: projects.locations.backends.domains

Ресурс: Домен

Доменное имя, связанное с серверной частью.

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
}
Поля
name

string

Идентификатор. Имя ресурса домена, например /projects/p/locations/l/backends/b/domains/foo.com .

displayName

string

Необязательный. Изменяемое удобочитаемое имя домена. Ограничение в 63 символа. например, prod domain .

createTime

string ( Timestamp format)

Только вывод. Время создания домена.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Только вывод. Время последнего обновления домена.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

type

enum ( Type )

Только вывод. Тип домена.

disabled

boolean

Необязательный. Отключен ли домен. По умолчанию ложь.

serve

object ( ServingBehavior )

Необязательный. Поведение обслуживания домена. Если указано, домен будет обслуживать контент, отличный от активного контента его серверной части.

customDomainStatus

object ( CustomDomainStatus )

Только вывод. Представляет состояние и конфигурацию домена типа CUSTOM . Он присутствует только на доменах этого типа.

reconciling

boolean

Только вывод. Поле, которое, если оно истинно, указывает на то, что сборка имеет текущий LRO.

deleteTime

string ( Timestamp format)

Только вывод. Время удаления домена.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

purgeTime

string ( Timestamp format)

Только вывод. Время, когда обратимо удаленный домен будет удален без возможности восстановления.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

labels

map (key: string, value: string)

Необязательный. Метки как пары ключ-значение.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

annotations

map (key: string, value: string)

Необязательный. Аннотации как пары ключ-значение.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

uid

string

Только вывод. Назначаемый системой уникальный идентификатор.

etag

string

Только вывод. Контрольная сумма, вычисляемая сервером на основе других значений; может быть отправлено при обновлении или удалении, чтобы гарантировать выполнение операции на ожидаемом ресурсе.

Тип

Тип домена.

Перечисления
TYPE_UNSPECIFIED Тип не указан (такого быть не должно).
DEFAULT Домены по умолчанию, домены, предоставляемые хостингом приложений и управляемые. Эти домены создаются автоматически вместе с родительским сервером и не могут быть удалены, кроме как путем удаления этого родителя, а также не могут быть перемещены на другой сервер. Домены по умолчанию можно отключить с помощью disabled поля.
CUSTOM Пользовательские домены, принадлежащие разработчикам. Пользовательские домены позволяют вам связать принадлежащий вам домен с серверной частью хостинга приложений и настроить этот домен для обслуживания содержимого вашей серверной части.

ОбслуживаниеПоведение

Указывает, будет ли хостинг приложений обслуживать контент в домене.

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.
}
Поля
Поле объединения serving_behavior . Если указано, настраивает поведение обслуживания домена. serving_behavior может быть только одним из следующих:
redirect

object ( Redirect )

Необязательный. Поведение перенаправления для домена, если оно предусмотрено.

Перенаправление

Определяет поведение перенаправления для домена.

JSON-представление 
{
  "uri": string,
  "status": string
}
Поля
uri

string

Необходимый. URI предполагаемого пункта назначения перенаправления. Этот URI будет добавлен к исходному пути запроса. Предполагается, что URI без схемы — это HTTPS.

status

string ( int64 format)

Необязательный. Код состояния, который будет использоваться в ответе на перенаправление. Должен быть действительным кодом состояния HTTP 3XX. По умолчанию 302, если отсутствует.

CustomDomainStatus

Статус связи личного домена с серверной частью.

JSON-представление 
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
Поля
hostState

enum ( HostState )

Только вывод. Отслеживает, обнаружен ли личный домен как надлежащим образом направляющий трафик на хостинг приложений.

ownershipState

enum ( OwnershipState )

Только вывод. Отслеживает, разрешено ли серверной части обслуживать контент в домене, на основе записей DNS домена.

certState

enum ( CertState )

Только вывод. Отслеживает статус SSL-сертификата для домена.

requiredDnsUpdates[]

object ( DnsUpdates )

Только вывод. Перечисляет записи, которые необходимо добавить или удалить в DNS личного домена, чтобы завершить настройку и начать обслуживание контента. Поле присутствует во время регистрации. Также присутствует после регистрации, если одно или несколько из вышеуказанных состояний не *_ACTIVE, что указывает на то, что записи DNS домена находятся в плохом состоянии.

issues[]

object ( Status )

Только вывод. Список проблем с настройкой домена. Позволяет пользователям самостоятельно исправлять проблемы с записями DNS.

ХостСтат

Хост-штат вашего домена. Состояние хоста определяется путем проверки каждого IP-адреса, связанного с вашим доменом, чтобы убедиться, что он обслуживается через соответствующий сегмент Origin хостинга приложений.

Перечисления
HOST_STATE_UNSPECIFIED Статус хоста вашего личного домена не указан. Сообщение недействительно, если оно не указано.
HOST_UNHOSTED Ваш личный домен не связан ни с какими IP-адресами.
HOST_UNREACHABLE Ваш личный домен недоступен. DNS-запросы служб хостинга приложений для поиска IP-адресов вашего домена привели к ошибкам. Дополнительные сведения см. в поле « issues вашего CustomDomainStatus .
HOST_NON_FAH В вашем домене есть только IP-адреса, которые в конечном итоге не разрешаются для хостинга приложений.
HOST_CONFLICT В вашем домене есть IP-адреса, которые разрешаются как для хостинга приложений, так и для других служб. Чтобы обеспечить согласованность результатов, удалите записи A и AAAA , относящиеся к службам, не связанным с хостингом приложений.
HOST_WRONG_SHARD В вашем домене есть IP-адреса, которые соответствуют неправильному региону и/или фрагменту репликации хостинга приложений.
HOST_ACTIVE Все запросы к вашему домену обслуживаются хостингом приложений через назначенный вашему домену сегмент. Если OwnershipState личного домена также имеет OWNERSHIP_ACTIVE , хостинг приложений обслуживает содержимое своей серверной части по запросам домена.

Состояние владения

Состояние владения вашим личным доменом.

Перечисления
OWNERSHIP_STATE_UNSPECIFIED Состояние владения вашим личным доменом не указано. Это никогда не должно произойти.
OWNERSHIP_MISSING Домен вашего личного домена не имеет записей о владельце, связанных с хостингом приложений; ни один сервер не имеет права обслуживать домен в этом сегменте Origin.
OWNERSHIP_UNREACHABLE Ваш личный домен недоступен. DNS-запросы служб хостинга приложений для поиска записей о владельце вашего домена привели к ошибкам. Дополнительные сведения см. в поле « issues вашего CustomDomainStatus .
OWNERSHIP_MISMATCH Ваш личный домен принадлежит другому личному домену хостинга приложений. Удалите конфликтующие записи и замените их записями для текущего личного домена.
OWNERSHIP_CONFLICT В вашем личном домене есть конфликтующие записи TXT , которые указывают на право собственности как вашего текущего личного домена, так и нескольких других. Удалите посторонние записи о владельце, чтобы предоставить текущему владельцу личного домена.
OWNERSHIP_PENDING DNS-записи вашего личного домена настроены правильно. Хостинг приложений передаст право собственности на ваш домен этому личному домену в течение 24 часов.
OWNERSHIP_ACTIVE Ваш личный домен владеет своим доменом.

Сертстате

Состояние SSL-сертификата хостинга приложений для вашего доменного имени. Это может отражать либо состояние фактического сертификата, либо, для новых пользовательских доменов, текущую попытку хостинга приложений создать сертификат.

Перечисления
CERT_STATE_UNSPECIFIED Состояние сертификата не указано. Сообщение недействительно, если оно не указано.
CERT_PREPARING Исходное состояние каждого сертификата отражает намерение хостинга приложений создать сертификат до того, как будут сделаны запросы в центр сертификации.
CERT_VALIDATING Хостинг приложений проверяет, находятся ли DNS-записи доменного имени в состоянии, позволяющем создавать сертификаты от его имени.
CERT_PROPAGATING Сертификат был недавно создан, и ему требуется время для распространения в балансировщиках нагрузки App Hosting.
CERT_ACTIVE Сертификат активен и обеспечивает безопасные соединения для доменных имен, которые он представляет.
CERT_EXPIRING_SOON Срок действия сертификата истекает, всем доменным именам на нем будут присвоены новые сертификаты.
CERT_EXPIRED Срок действия сертификата истек. Хостинг приложений больше не может предоставлять защищенный контент на вашем доменном имени.

DNSОбновления

Набор обновлений записей DNS, которые вам следует внести, чтобы позволить хостингу приложений обслуживать защищенный контент в ответ на запросы к вашему домену. Эти обновления отображают текущее состояние DNS-записей вашего домена и связанных с ним поддоменов на момент последнего запроса хостинга приложений, а также желаемый набор записей, который хостинг приложений должен просмотреть, прежде чем ваш личный домен сможет стать полностью активным.

JSON-представление 
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
Поля
domainName

string

Только вывод. Доменное имя, к которому относятся обновления DNS.

discovered[]

object ( DnsRecordSet )

Только вывод. Набор записей DNS, обнаруженных хостингом приложений при проверке домена.

desired[]

object ( DnsRecordSet )

Только вывод. Набор записей DNS, необходимый хостингу приложений для предоставления безопасного контента в домене.

checkTime

string ( Timestamp format)

Только вывод. Когда в последний раз хостинг приложений проверял DNS-записи вашего личного домена.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Днсрекордсет

Набор записей DNS, относящихся к настройке и обслуживанию личного домена на хостинге приложений.

JSON-представление 
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
Поля
domainName

string

Только вывод. Доменное имя, к которому относится набор записей.

checkError

object ( Status )

Только вывод. Ошибка служб хостинга приложений при запросе DNS-записей вашего домена. Примечание. Хостинг приложений игнорирует ошибки NXDOMAIN , поскольку они обычно означают, что доменное имя еще не настроено.

records[]

object ( DnsRecord )

Только вывод. Записи на домене.

ДнсРекорд

Представление записей DNS для домена.

Записи DNS — это записи ресурсов, которые определяют, как системы и службы должны вести себя при обработке запросов к домену. Например, когда вы добавляете записи A в записи DNS вашего домена, вы информируете другие системы (например, веб-браузеры ваших пользователей) о необходимости связаться с этими IPv4-адресами для получения ресурсов, относящихся к вашему домену (например, файлов хостинга приложений).

JSON-представление 
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
Поля
domainName

string

Только вывод. Домен, к которому относится запись, например foo.bar.com. .

type

enum ( Type )

Только вывод. Тип записи, определяющий, какие данные содержит запись.

rdata

string

Только вывод. Данные записи. Значение значения зависит от типа записи: - A и AAAA: IP-адреса домена. - CNAME: еще один домен для проверки записей. - TXT: произвольные текстовые строки, связанные с доменом. Хостинг приложений использует записи TXT, чтобы определить, какие проекты Firebase имеют разрешение действовать от имени домена. - CAA: флаги, тег и значение записи, например 0 issue "pki.goog" .

requiredAction

enum ( Action )

Только вывод. Перечисление, указывающее необходимое действие для этой записи. Заполняется, когда запись является частью необходимого изменения в discovered или desired наборе записей DnsUpdates .

relevantState[]

enum ( CustomDomainState )

Только вывод. Перечисление, указывающее, к какому штату(ам) относится эта запись DNS. Заполняется для всех записей с обязательным действием ADD или REMOVE .

Тип

Тип записи DNS, включая A , TXT , AAAA и CAA .

Перечисления
TYPE_UNSPECIFIED Тип записи не указан. Сообщение недействительно, если оно не указано.
A Запись A , как определено в RFC 1035 . Записи определяют, на какие IPv4-адреса домен направляет трафик.
CNAME Запись CNAME , как определено в RFC 1035 . Записи CNAME или канонического имени сопоставляют домен с другим каноническим доменом. Если запись CNAME присутствует, она должна быть единственной записью в домене.
TXT Запись TXT , как определено в RFC 1035 . Записи TXT содержат произвольные текстовые данные в домене. Хостинг использует записи TXT , чтобы определить, какой проект Firebase имеет разрешение действовать в домене.
AAAA Запись AAAA, как определено в RFC 3596, записи AAAA определяют, на какие адреса IPv6 домен направляет трафик.
CAA

Запись CAA, как определено в RFC 6844 . Записи CAA, или авторизации центра сертификации, определяют, какие центры сертификации (организации, выпускающие сертификаты SSL) уполномочены выпускать сертификаты для домена. Хостинг приложений использует pki.goog в качестве основного центра сертификации.

CAA записывает каскад. Запись CAA на foo.com также применяется к bar.foo.com , если bar.foo.com не имеет собственного набора записей CAA.

Записи CAA не являются обязательными. Если домен и его родители не имеют записей CAA, все центры сертификации имеют право выпускать сертификаты от его имени. Как правило, хостинг приложений просит вас изменить записи CAA только в том случае, если это необходимо для разблокировки создания сертификата SSL.

Действие

Тип действия, которое необходимо выполнить над этой записью DNS, чтобы настроить свой домен для использования с хостингом приложений.

Перечисления
NONE Никаких действий не требуется.
ADD Добавьте эту запись в свои записи DNS.
REMOVE Удалите эту запись из своих записей DNS.

Кастомдомаменстате

Набор состояний, необходимых для нормального функционирования пользовательского домена.

Перечисления
CUSTOM_DOMAIN_STATE_UNSPECIFIED Это сообщение недействительно, если оно не указано.
HOST_STATE Состояние хоста личного домена.
OWNERSHIP_STATE Состояние владения пользовательским доменом.
CERT_STATE Состояние сертификата личного домена.

Методы

create

 Связывает новый домен с серверной частью.

delete

 Удаляет один домен.

get

 Получает информацию о домене.

list

 Перечисляет домены серверной части.

patch

 Обновляет информацию для одного домена.