REST Resource: projects.locations.backends.domains

Zasób: domena

Nazwa domeny powiązana z backendem.

Zapis 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
}
Pola
name

string

Identyfikator. Nazwa zasobu domeny, np. /projects/p/locations/l/backends/b/domains/foo.com
displayName

string

Opcjonalnie. Zmienna, zrozumiała dla człowieka nazwa domeny. Obowiązuje limit 63 znaków. np. prod domain
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia domeny.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji domeny.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
type

enum (Type)

Tylko dane wyjściowe. Typ domeny.
disabled

boolean

Opcjonalnie. Wskazuje, czy domena jest wyłączona. Wartość domyślna to fałsz.
serve

object (ServingBehavior)

Opcjonalnie. Sposób udostępniania domeny. Jeśli określisz nazwę domeny, w domenie będą wyświetlane treści inne niż bieżące treści z backendu.
customDomainStatus

object (CustomDomainStatus)

Tylko dane wyjściowe. Reprezentuje stan i konfigurację domeny typu CUSTOM. Pojawia się tylko w domenach tego typu.
reconciling

boolean

Tylko dane wyjściowe. Pole, które (jeśli ma wartość true) wskazuje, że kompilacja ma trwającą LRO.
deleteTime

string (Timestamp format)

Tylko dane wyjściowe. Czas usunięcia domeny.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
purgeTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, kiedy domena przeniesiona do kosza zostanie trwale usunięta i renderowana.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Opcjonalnie. Etykiety jako pary klucz-wartość.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Opcjonalnie. Adnotacje jako pary klucz-wartość.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Tylko dane wyjściowe. Przypisany przez system, unikalny identyfikator.
etag

string

Tylko dane wyjściowe. suma kontrolna obliczona przez serwer na podstawie innych wartości; mogą być wysyłane przy aktualizacji lub usunięcia w celu zapewnienia, że operacja zostanie wykonana na oczekiwanym zasobie.

Typ

Typ domeny.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nie jest określony (nie powinno tak się zdarzyć).
DEFAULT Domyślne domeny udostępnione i zarządzane przez App Hosting. Te domeny są tworzone automatycznie z backendem nadrzędnym. Można je usunąć tylko przez usunięcie tej domeny nadrzędnej. Nie można ich też przenieść do innego backendu. Domyślne domeny można wyłączyć za pomocą pola disabled.
CUSTOM Niestandardowe domeny należące do dewelopera. Domeny niestandardowe umożliwiają powiązanie posiadanej domeny z backendem App Hosting i skonfigurowanie tej domeny do obsługi treści backendu.

Sposób wyświetlania

Wskazuje, czy App Hosting będzie wyświetlać treści w domenie.

Zapis 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.
}
Pola
Pole sumy serving_behavior. Jeśli jest określony, dostosowuje działanie wyświetlania domeny. serving_behavior może mieć tylko jedną z tych wartości:
redirect

object (Redirect)

Opcjonalnie. Przekierowywanie domeny, jeśli zostało podane.

Przekierowanie

Określa zachowanie przekierowania w domenie.

Zapis JSON 
{
  "uri": string,
  "status": string
}
Pola
uri

string

Wymagane. Identyfikator URI docelowego miejsca docelowego przekierowania. Ten identyfikator URI zostanie dołączony do oryginalnej ścieżki żądania. Identyfikator URI bez schematu jest uznawany za HTTPS.
status

string (int64 format)

Opcjonalnie. Kod stanu używany w odpowiedzi przekierowującej. To musi być prawidłowy kod stanu HTTP 3XX. Jeśli jej nie ma, domyślna wartość to 302.

Stan domeny niestandardowej

Stan połączenia domeny niestandardowej z backendem.

Zapis JSON 
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
Pola
hostState

enum (HostState)

Tylko dane wyjściowe. Śledzi, czy wykryto, że domena niestandardowa kieruje ruch do App Hosting.
ownershipState

enum (OwnershipState)

Tylko dane wyjściowe. Śledzi, czy backend może wyświetlać treści w domenie na podstawie rekordów DNS domeny.
certState

enum (CertState)

Tylko dane wyjściowe. Śledzi stan certyfikatu SSL dla domeny.
requiredDnsUpdates[]

object (DnsUpdates)

Tylko dane wyjściowe. Zawiera listę rekordów, które należy dodać do DNS domeny niestandardowej lub z niej usunąć, aby zakończyć konfigurację i zacząć udostępniać treści. Pole jest obecne podczas wprowadzania. Występuje również po wprowadzeniu, jeśli co najmniej jeden z powyższych stanów nie ma wartości *_ACTIVE, co oznacza, że rekordy DNS domeny są w złym stanie.
issues[]

object (Status)

Tylko dane wyjściowe. Lista problemów z konfiguracją domeny. Umożliwia użytkownikom samodzielne rozwiązywanie problemów z rekordami DNS.

HostState

Stan hosta Twojej domeny. Stan hosta jest określany przez sprawdzenie każdego adresu IP powiązanego z Twoją domeną w celu sprawdzenia, czy serwer działa przez odpowiedni fragment punktu początkowego App Hosting.

Wartości w polu enum
HOST_STATE_UNSPECIFIED Stan hosta domeny niestandardowej jest nieokreślony. Jeśli to nie zostanie określone, komunikat jest nieprawidłowy.
HOST_UNHOSTED Twoja domena niestandardowa nie jest powiązana z żadnym adresem IP.
HOST_UNREACHABLE Nie można uzyskać dostępu do Twojej domeny niestandardowej. App Hosting Services Zapytania DNS służące do znalezienia adresów IP Twojej domeny spowodowały błędy. Więcej informacji znajdziesz w polu issues na koncie CustomDomainStatus.
HOST_NON_FAH Twoja domena ma tylko adresy IP, które nie są ostatecznie powiązane z App Hosting.
HOST_CONFLICT Twoja domena ma adresy IP, które są dostępne zarówno w App Hosting, jak i w innych usługach. Aby zapewnić spójne wyniki, usuń rekordy A i AAAA związane z usługami niezwiązanymi z hostowaniem aplikacji.
HOST_WRONG_SHARD Twoja domena ma adresy IP, które prowadzą do nieprawidłowego regionu lub fragmentu replikacji w App Hosting.
HOST_ACTIVE Wszystkie żądania skierowane do Twojej domeny są obsługiwane przez App Hosting przez przypisany fragment Twojej domeny. Jeśli OwnershipState domeny niestandardowej to także OWNERSHIP_ACTIVE, App Hosting będzie udostępniać treści backendu dla żądań w domenie.

Stan własności

Stan własności domeny niestandardowej.

Wartości w polu enum
OWNERSHIP_STATE_UNSPECIFIED Stan własności domeny niestandardowej jest nieokreślony. To nie powinno się nigdy zdarzyć.
OWNERSHIP_MISSING Domena Twojej domeny niestandardowej nie ma rekordów własności związanych z hostingiem aplikacji. żaden backend nie ma uprawnień do udostępniania w domenie w tym fragmencie źródła.
OWNERSHIP_UNREACHABLE Nie można uzyskać dostępu do Twojej domeny niestandardowej. App Hosting Services Zapytania DNS w celu znalezienia rekordów własności domeny spowodowały błędy. Więcej informacji znajdziesz w polu issues na koncie CustomDomainStatus.
OWNERSHIP_MISMATCH Twoja domena niestandardowa należy do innej domeny niestandardowej w App Hosting. Usuń rekordy powodujące konflikty i zastąp je rekordami bieżącej domeny niestandardowej.
OWNERSHIP_CONFLICT W Twojej domenie niestandardowej występują sprzeczne rekordy TXT, które wskazują prawa własności w jednej lub kilku innych domenach niestandardowej. Usuń zbędne rekordy własności, aby przypisać bieżące własność domeny niestandardowej.
OWNERSHIP_PENDING Rekordy DNS domeny niestandardowej są skonfigurowane prawidłowo. App Hosting przeniesie prawo własności Twojej domeny do tej domeny niestandardowej w ciągu 24 godzin.
OWNERSHIP_ACTIVE Twoja domena niestandardowa jest właścicielem domeny.

Certyfikat CertState

Stan certyfikatu SSL Twojej domeny, jaki posiada App Hosting. Może to być stan rzeczywistego certyfikatu lub (w przypadku nowych domen niestandardowych) próba utworzenia certyfikatu przez App Hosting.

Wartości w polu enum
CERT_STATE_UNSPECIFIED Stan certyfikatu jest nieokreślony. Jeśli to nie zostanie określone, komunikat jest nieprawidłowy.
CERT_PREPARING Początkowy stan każdego certyfikatu odzwierciedla intencje App Hostingu dotyczące utworzenia certyfikatu przed wysłaniem żądań do urzędu certyfikacji.
CERT_VALIDATING App Hosting sprawdza, czy rekordy DNS nazwy domeny są w stanie zezwalającym na tworzenie certyfikatów w jej imieniu.
CERT_PROPAGATING Certyfikat został utworzony niedawno i wymaga czasu na rozpowszechnienie go w systemach równoważenia obciążenia App Hosting.
CERT_ACTIVE Certyfikat jest aktywny i zapewnia bezpieczne połączenia dla reprezentowanych przez niego nazw domen.
CERT_EXPIRING_SOON Certyfikat wygaśnie, wszystkie jego nazwy domen otrzymają nowe certyfikaty.
CERT_EXPIRED Certyfikat wygasł. App Hosting nie może już obsługiwać treści zabezpieczonych w Twojej nazwie domeny.

Aktualizacje DNS

Zestaw aktualizacji rekordów DNS, które należy wprowadzić, aby zezwolić App Hostingowi na udostępnianie bezpiecznych treści w odpowiedzi na żądania wysyłane do Twojej domeny. Aktualizacje przedstawiają bieżący stan Twojej domeny i powiązanych z nią subdomen Rekordy DNS, kiedy usługa App Hosting ostatni raz wysyłała do nich zapytania, oraz żądany zestaw rekordów, które App Hosting musi przetworzyć, zanim będzie można w pełni aktywować domenę niestandardową.

Zapis JSON 
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
Pola
domainName

string

Tylko dane wyjściowe. Nazwa domeny, której dotyczą aktualizacje DNS.
discovered[]

object (DnsRecordSet)

Tylko dane wyjściowe. Zestaw rekordów DNS wykrytych przez usługę App Hosting podczas sprawdzania domeny.
desired[]

object (DnsRecordSet)

Tylko dane wyjściowe. Zbiór rekordów DNS wymaganych przez App Hosting do udostępniania bezpiecznych treści w domenie.
checkTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniego sprawdzenia rekordów DNS domeny niestandardowej przez App Hosting.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Zbiór rekordów DNS

Zestaw rekordów DNS związanych z konfiguracją i obsługą domeny niestandardowej w App Hosting.

Zapis JSON 
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
Pola
domainName

string

Tylko dane wyjściowe. Nazwa domeny, której dotyczy zestaw rekordów.
checkError

object (Status)

Tylko dane wyjściowe. Podczas wysyłania zapytań dotyczących rekordów DNS domeny wystąpił błąd usług App Hosting. Uwaga: App Hosting ignoruje błędy NXDOMAIN, ponieważ zwykle oznaczają one po prostu, że nazwa domeny nie została jeszcze skonfigurowana.
records[]

object (DnsRecord)

Tylko dane wyjściowe. Rekordy w domenie.

Rekord DNS

Reprezentacja rekordów DNS domeny.

Rekordy DNS to rekordy zasobów określające, jak powinny działać systemy i usługi podczas obsługi żądań dotyczących domeny. Na przykład gdy dodajesz rekordy A do rekordów DNS domeny, informujesz inne systemy (takie jak przeglądarki użytkowników) o konieczności skontaktowania się z tymi adresami IPv4 w celu pobrania zasobów związanych z Twoją domeną (na przykład plików App Hosting).

Zapis JSON 
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
Pola
domainName

string

Tylko dane wyjściowe. Domena, której dotyczy rekord, np. foo.bar.com.
type

enum (Type)

Tylko dane wyjściowe. Typ rekordu, który określa, jakie dane zawiera.
rdata

string

Tylko dane wyjściowe. Dane rekordu. Znaczenie wartości zależy od typu rekordu: - A i AAAA: adresy IP domeny. – CNAME: inna domena, która ma sprawdzić rekordy. – TXT: dowolne ciągi tekstowe powiązane z domeną. App Hosting wykorzystuje rekordy TXT do określania, które projekty Firebase mają uprawnienia do działania w imieniu domeny. – CAA: flagi rekordu, tag i wartość, np. 0 issue "pki.goog"
requiredAction

enum (Action)

Tylko dane wyjściowe. Enum, które wskazuje wymagane działanie w przypadku tego rekordu. Wartość wypełniana, gdy rekord jest częścią wymaganej zmiany w zestawie rekordów discovered lub desired DnsUpdates.
relevantState[]

enum (CustomDomainState)

Tylko dane wyjściowe. Wyliczenie wskazujące, do których stanów ma zastosowanie ten rekord DNS. Wartość podawana w przypadku wszystkich rekordów z wymaganym działaniem ADD lub REMOVE.

Typ

Typ rekordu DNS, w tym A, TXT, AAAA i CAA.

Wartości w polu enum
TYPE_UNSPECIFIED Typ rekordu jest nieokreślony. Jeśli to nie zostanie określone, komunikat jest nieprawidłowy.
A Rekord A określony w RFC 1035. Rekordy A określają, na które adresy IPv4 kieruje ruch,
CNAME Rekord CNAME określony w RFC 1035. Rekordy nazwy kanonicznej CNAME mapują domenę na inną, kanoniczną domenę. Jeśli rekord CNAME istnieje, powinien być on jedynym rekordem w domenie.
TXT Rekord TXT określony w RFC 1035. Rekordy TXT zawierają dowolne dane tekstowe w domenie. Hosting używa rekordów TXT do określenia, który projekt Firebase ma uprawnienia do działania w domenie.
AAAA Rekord AAAA, zgodnie z definicją w RFC 3596, określa, na które adresy IPv6 ma kierować ruch.
CAA

Rekord CAA zgodny z definicją podaną w RFC 6844. Rekordy CAA (ang. Certificate Authority Authorization, autoryzacja urzędu certyfikacji) określają, które urzędy certyfikacji (organizacje generujące certyfikaty SSL) są uprawnione do wygenerowania certyfikatu dla domeny. App Hosting używa pki.goog jako głównego urzędu certyfikacji.

Rekordy CAA działają kaskadowo. Rekord CAA w domenie foo.com ma również zastosowanie do bar.foo.com, chyba że bar.foo.com ma własny zestaw rekordów CAA.

Rekordy CAA są opcjonalne. Jeśli domena i jej podmioty nadrzędne nie mają rekordów CAA, wszystkie urzędy certyfikacji są uprawnione do generowania certyfikatów w jej imieniu. Ogólnie rzecz biorąc, App Hosting prosi o zmianę rekordów CAA tylko wtedy, gdy jest to wymagane do odblokowania tworzenia certyfikatu SSL.

Działanie

Typ działania, które należy wykonać na tym rekordzie DNS, aby skonfigurować domenę na potrzeby App Hosting.

Wartości w polu enum
NONE Nie musisz nic robić.
ADD Dodaj ten rekord do rekordów DNS.
REMOVE Usuń ten rekord z rekordów DNS.

CustomDomainState (Stan domeny niestandardowej)

Zbiór stanów związanych z prawidłowym działaniem domeny niestandardowej.

Wartości w polu enum
CUSTOM_DOMAIN_STATE_UNSPECIFIED Ten komunikat jest nieprawidłowy, jeśli nie jest określony.
HOST_STATE Stan hosta domeny niestandardowej.
OWNERSHIP_STATE Stan własności domeny niestandardowej.
CERT_STATE Stan certyfikatu domeny niestandardowej.

Metody

create

 Łączy nową domenę z backendem.

delete

 Usuwa pojedynczą domenę.

get

 Pobiera informacje o domenie.

list

 Wyświetla listę domen backendu.

patch

 Aktualizuje informacje o pojedynczej domenie.