REST Resource: projects.sites.customDomains

Zasób: CustomDomain

CustomDomain to encja łącząca nazwę domeny z witryną w Hostingu Firebase. Dodaj do swojej witryny atrybut CustomDomain, aby zezwolić usłudze Hosting na udostępnianie treści witryny w odpowiedzi na żądania wysyłane pod kątem Twojej nazwy domeny.

Zapis JSON
{
  "name": string,
  "annotations": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "expireTime": string,
  "etag": string,
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "requiredDnsUpdates": {
    object (DnsUpdates)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "certPreference": enum (Type),
  "cert": {
    object (Certificate)
  },
  "redirectTarget": string,
  "reconciling": boolean,
  "labels": {
    string: string,
    ...
  }
}
Pola
name

string

Tylko dane wyjściowe. Pełna nazwa elementu CustomDomain.

annotations

map (key: string, value: string)

Adnotacje, które możesz dodać, aby zachować metadane zrozumiałe dla człowieka i dla komputera (CustomDomain).

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

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia domeny niestandardowej.

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. Ostatnia aktualizacja: CustomDomain.

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".

deleteTime

string (Timestamp format)

Tylko dane wyjściowe. czas usunięcia obiektu CustomDomain; wartość null w przypadku domen niestandardowych, które nie zostały usunięte. Usunięte domeny niestandardowe są przechowywane przez około 30 dni. Po tym czasie Hosting całkowicie je usuwa. Aby przywrócić usuniętą domenę niestandardową, wyślij prośbę customDomains.undelete.

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".

expireTime

string (Timestamp format)

Tylko dane wyjściowe. Minimalny czas, po którym CustomDomain przeniesiono do kosza jest całkowicie usuwane z Hostingu; wartość null w przypadku domen niestandardowych, które nie zostały usunięte.

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".

etag

string

Tylko dane wyjściowe. Ciąg znaków reprezentujący bieżący stan obiektu CustomDomain i umożliwiający potwierdzenie jego początkowego stanu w żądaniach, które powodują jego modyfikację. Używaj tagu, aby zapewnić spójność podczas tworzenia żądań customDomains.patch, customDomains.delete i customDomains.undelete.

hostState

enum (HostState)

Tylko dane wyjściowe. HostState nazwy domeny, do której odnosi się ten element (CustomDomain).

ownershipState

enum (OwnershipState)

Tylko dane wyjściowe. OwnershipState nazwy domeny, do której odnosi się ten element (CustomDomain).

requiredDnsUpdates

object (DnsUpdates)

Tylko dane wyjściowe. Zestaw aktualizacji rekordów DNS nazwy domeny, aby umożliwić usłudze Hosting udostępnianie bezpiecznych treści w jej imieniu.

issues[]

object (Status)

Tylko dane wyjściowe. Zestaw błędów, które wystąpiły przez systemy hostingowe, gdy próbowano ustalić, czy Hosting może udostępniać bezpieczne treści dla Twojej nazwy domeny. Rozwiąż te problemy, aby mieć pewność, że CustomDomain działa prawidłowo.

certPreference

enum (Type)

Pole umożliwiające określenie typu certyfikatu SSL tworzonego przez Hosting dla nazwy domeny. Domeny niestandardowe abonamentu Spark mają dostęp tylko do typu certyfikatu GROUPED, a domeny z abonamentem Blaze mogą wybrać dowolną opcję.

cert

object (Certificate)

Tylko dane wyjściowe. Certyfikat SSL dla tej nazwy domeny niestandardowej w Hostingu. W przypadku nowych domen niestandardowych jest to często sposób utworzenia certyfikatu przez Hosting, a nie rzeczywisty certyfikat. Sprawdź pole state, aby dowiedzieć się więcej.

redirectTarget

string

Nazwa domeny, na którą powinien kierować ruch CustomDomain. Jeśli zostanie określony, Hosting będzie odpowiadać na żądania skierowane do tej domeny niestandardowej za pomocą kodu HTTP 301 i kierować ruch na podany adres redirectTarget.

reconciling

boolean

Tylko dane wyjściowe. Pole, które (jeśli ma wartość true) wskazuje, że systemy Hostingu starają się dopasować stan domeny niestandardowej do preferowanego stanu. Najczęściej jest to true podczas początkowego udostępniania elementu CustomDomain po żądaniu customDomains.create lub podczas tworzenia nowego certyfikatu SSL pasującego do zaktualizowanego dokumentu certPreference po żądaniu customDomains.patch.

labels

map (key: string, value: string)

Etykiety używane do dodatkowych metadanych lub filtrowania.

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

HostState

Stan hosta Twojej nazwy domeny. Stan hosta jest określany przez sprawdzenie każdego adresu IP powiązanego z nazwą Twojej domeny w celu sprawdzenia, czy udostępnia on treści z Hostingu.

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 Nazwa domeny niestandardowej nie jest powiązana z żadnym adresem IP.
HOST_UNREACHABLE Nie można uzyskać dostępu do nazwy domeny Twojej domeny. Usługi hostingowe Zapytania DNS w celu znalezienia adresów IP Twojej domeny spowodowały błędy. Więcej informacji znajdziesz w polu issues obiektu CustomDomain.
HOST_MISMATCH Nazwa domeny Twojej domeny niestandardowej zawiera adresy IP, które nie są ostatecznie powiązane z Hostingiem.
HOST_CONFLICT Nazwa domeny niestandardowej zawiera adresy IP, które są dostępne zarówno w Hostingu, jak i w innych usługach. Aby zapewnić spójne wyniki, usuń rekordy A i AAAA powiązane z usługami niehostowanymi.
HOST_ACTIVE Wszystkie żądania dotyczące nazwy domeny Twojej domeny są obsługiwane przez Hosting. Jeśli OwnershipState domeny niestandardowej to również ACTIVE, Hosting będzie udostępniać treści z Twojej witryny w usłudze hostingowej pod nazwą domeny.

Stan własności

Stan własności domeny. Domena może być własnością maksymalnie jednej witryny Hostingu Firebase. Własność można określić na 2 sposoby:

* TXT records: A TXT record on the domain in the form
`hosting-site=[siteId]`.
* CNAME records: A CNAME record that points to a Hosting site's default
domain.

Jeśli CustomDomain znajduje się w OwnershipState innym niż OWNERSHIP_ACTIVE przez ponad 30 dni i nie był aktualizowany od co najmniej 30 dni, systemy własności Hostingu usuwają CustomDomain. Aby przywrócić usunięte konto CustomDomain, wyślij prośbę o: customDomains.undelete.

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 nazwa domeny Twojej domeny niestandardowej nie zawiera rekordów własności związanych z Hostingiem; Żaden projekt Firebase nie ma uprawnień do działania w imieniu nazwy domeny.
OWNERSHIP_UNREACHABLE Nie można uzyskać dostępu do nazwy domeny Twojej domeny. Usługi hostingowe Zapytania DNS w celu znalezienia rekordów własności nazwy domeny spowodowały błędy. Więcej informacji znajdziesz w polu issues obiektu CustomDomain.
OWNERSHIP_MISMATCH Nazwa domeny Twojej domeny niestandardowej należy do innego projektu Firebase. Usuń powodujące konflikt rekordy TXT i zastąp je rekordami związanymi z bieżącym projektem Firebase.
OWNERSHIP_CONFLICT Nazwa domeny Twojej domeny niestandardowej zawiera rekordy TXT powodujące konflikty, które wskazują własności zarówno przez bieżący projekt Firebase, jak i inny projekt. Usuń rekordy własności innego projektu, aby przypisać bieżącą własność projektu.
OWNERSHIP_PENDING Rekordy DNS domeny niestandardowej są skonfigurowane prawidłowo. Hosting przeniesie prawo własności do Twojej domeny na to urządzenie CustomDomain w ciągu 24 godzin.
OWNERSHIP_ACTIVE Nazwa domeny Twojej domeny niestandardowej zawiera rekordy (TXT), które przyznają projektowi uprawnienia do działania w jej imieniu.

Aktualizacje DNS

Zestaw aktualizacji rekordów DNS, które należy wprowadzić, aby zezwolić usłudze Hosting na udostępnianie bezpiecznych treści w odpowiedzi na żądania wysyłane pod kątem Twojej nazwy domeny. Aktualizacje te przedstawiają bieżący stan rekordów DNS Twojej nazwy domeny w momencie ostatniego zapytania ich przez Hosting oraz żądany zestaw rekordów, które musi mieć Hosting, zanim będzie można w pełni aktywować domenę niestandardową.

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

object (DnsRecordSet)

Zestaw rekordów DNS wykrytych przez hosting podczas sprawdzania domeny.

desired[]

object (DnsRecordSet)

Zbiór rekordów DNS Hosting musi udostępniać bezpieczną treść w domenie.

checkTime

string (Timestamp format)

Czas ostatniego sprawdzenia rekordów DNS domeny niestandardowej przez 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 Hostingu Firebase.

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 nazwy domeny wystąpił błąd usług hostingu. Uwaga: 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

Rekordy DNS to rekordy zasobów określające, jak powinny działać systemy i usługi podczas obsługi żądań dotyczących nazwy domeny. Na przykład gdy dodajesz rekordy A do rekordów DNS nazwy domeny, informujesz inne systemy (takie jak przeglądarki użytkowników), aby skontaktowały się z tymi adresami IPv4 w celu pobrania zasobów związanych z nazwą Twojej domeny (na przykład plików witryny w Hostingu).

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

string

Tylko dane wyjściowe. Nazwa domeny, 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 nazwy domeny. – CNAME: inna domena, która ma sprawdzić rekordy. – TXT: dowolne ciągi tekstowe powiązane z nazwą domeny. Hosting używa rekordów TXT do określania, które projekty Firebase mają uprawnienia do działania w imieniu nazwy 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.

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 dana nazwa domeny kieruje ruch.
CNAME Rekord CNAME określony w RFC 1035. Rekordy nazwy kanonicznej CNAME mapują nazwę domeny na inną, kanoniczną nazwę domeny. Jeśli rekord CNAME istnieje, powinien on być jedynym rekordem w danej nazwie domeny.
TXT Rekord TXT określony w RFC 1035. Rekordy TXT zawierają dowolne dane tekstowe w nazwie domeny. Hosting używa rekordów TXT do określenia, który projekt Firebase ma uprawnienia do działania w przypadku nazwy domeny.
AAAA Rekord AAAA, zgodnie z definicją w RFC 3596, określa adresy IPv6, do których nazwa domeny kieruje 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 nazwy domeny. Hosting Firebase 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 nazwa domeny i jej jednostki nadrzędne nie mają rekordów CAA, wszystkie urzędy certyfikacji są uprawnione do generowania certyfikatów w jej imieniu. Hosting prosi o zmianę rekordów CAA tylko wtedy, gdy jest to wymagane do odblokowania tworzenia certyfikatu SSL.

Działanie

Działanie to typ działania, które należy wykonać na tym rekordzie DNS, aby skonfigurować domenę na potrzeby Hostingu Firebase.

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.

Typ

Typ certyfikatu. Określa, w jaki sposób systemy Hostingu obsługują tworzenie i utrzymywanie certyfikatu.

Wartości w polu enum
TYPE_UNSPECIFIED Typ certyfikatu jest nieokreślony. Jeśli to nie zostanie określone, komunikat jest nieprawidłowy.
TEMPORARY Typ certyfikatu o ograniczonym czasie ważności, który tymczasowo pokrywa nazwę domeny, podczas gdy Hosting tworzy certyfikat trwały.
GROUPED Standardowy certyfikat dla domen niestandardowych w ramach abonamentu Spark.
PROJECT_GROUPED Tylko abonament Blaze. Certyfikat, który obejmuje od 1 do 100 nazw domen z domenami niestandardowymi w tym samym projekcie Firebase.
DEDICATED Tylko abonament Blaze. Certyfikat, który obejmuje pojedynczą nazwę domeny.

Certyfikat

Certyfikat SSL używany do zapewnienia pełnego szyfrowania w przypadku żądań wysyłanych skierowanych do Twojej nazwy domeny. Certificate może być rzeczywistym certyfikatem SSL lub – w przypadku nowo utworzonych domen niestandardowych – zamiarem utworzenia takiego certyfikatu przez Hosting.

Zapis JSON
{
  "type": enum (Type),
  "state": enum (CertState),
  "verification": {
    object (CertVerification)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "createTime": string,
  "expireTime": string
}
Pola
type

enum (Type)

Tylko dane wyjściowe. Typ certyfikatu.

state

enum (CertState)

Tylko dane wyjściowe. Stan certyfikatu. Tylko stany CERT_ACTIVE i CERT_EXPIRING_SOON zapewniają ochronę protokołu SSL dla nazwy domeny. Jeśli stan to PROPAGATING, a usługa Hosting miał wcześniej aktywny certyfikat dla nazwy domeny, certyfikat ten zapewnia obsługę protokołu SSL dla nazwy domeny do momentu rozpowszechnienia bieżącego certyfikatu.

verification

object (CertVerification)

Tylko dane wyjściowe. Zestaw testów ACME, które możesz dodać do swoich rekordów DNS lub do istniejącego dostawcy usług hostingowych, aby umożliwić usłudze Hosting utworzenie certyfikatu SSL dla Twojej nazwy domeny, zanim skierujesz ruch do usługi hostingowej. Możesz skorzystać z tych wyzwań w ramach przejścia ze starego dostawcy na usługę Hosting bez przestojów.

issues[]

object (Status)

Tylko dane wyjściowe. Zestaw błędów, które wystąpiły w Hostingu podczas próby utworzenia certyfikatu dla nazwy Twojej domeny. Rozwiąż te problemy, aby mieć pewność, że Hosting może zapewniać bezpieczną komunikację z użytkownikami Twojej witryny.

createTime

string (Timestamp format)

Tylko dane wyjściowe. czas utworzenia certyfikatu, W przypadku certyfikatów TEMPORARY jest to czas, w którym Hosting został po raz pierwszy wygenerowany dla Twojej nazwy domeny. W przypadku pozostałych typów certyfikatów jest to czas utworzenia certyfikatu.

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".

expireTime

string (Timestamp format)

Tylko dane wyjściowe. datę ważności certyfikatu; Po tym czasie certyfikat nie będzie już mógł być używany do zapewnienia bezpiecznej komunikacji między Hostingiem a użytkownikami Twojej witryny.

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".

Certyfikat CertState

Stan certyfikatu SSL Twojej domeny w Hostingu. Może to być stan rzeczywistego certyfikatu lub (w przypadku nowych domen niestandardowych) próbę utworzenia certyfikatu przez 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 odpowiada intencji Hostingu do utworzenia certyfikatu przed wysłaniem żądań do urzędu certyfikacji.
CERT_VALIDATING 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 potrzebuje czasu na rozpowszechnienie go w sieci CDN Hostingu.
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ł. Hosting nie może już obsługiwać treści zabezpieczonych w Twojej nazwie domeny.

Certyfikacja

Zestaw testów ACME, których możesz użyć, aby umożliwić Hostingowi utworzenie certyfikatu SSL dla Twojej nazwy domeny przed skierowaniem ruchu na serwery Hostingu. Użyj testu zabezpieczającego DNS lub HTTP. nie musisz podawać obu.

Zapis JSON
{
  "dns": {
    object (DnsUpdates)
  },
  "http": {
    object (HttpUpdate)
  }
}
Pola
dns

object (DnsUpdates)

Tylko dane wyjściowe. Rekord TXT, który musisz dodać do rekordów DNS, aby potwierdzić, że chcesz zezwolić usłudze Hosting na utworzenie certyfikatu SSL dla Twojej nazwy domeny.

http

object (HttpUpdate)

Tylko dane wyjściowe. Plik, który należy dodać do istniejącej usługi hostingowej niebędącej hostingiem, aby potwierdzić, że chcesz zezwolić usłudze Hosting na utworzenie certyfikatu SSL dla nazwy Twojej domeny.

HttpUpdate

Plik, który możesz dodać do istniejącej usługi hostingowej niebędącej hostingiem, aby potwierdzić, że chcesz zezwolić urzędom certyfikacji Hostingu na utworzenie certyfikatu SSL dla Twojej domeny.

Zapis JSON
{
  "path": string,
  "desired": string,
  "discovered": string,
  "lastCheckTime": string,
  "checkError": {
    object (Status)
  }
}
Pola
path

string

Tylko dane wyjściowe. Ścieżka do pliku.

desired

string

Tylko dane wyjściowe. Ciąg tekstowy wyświetlany na ścieżce.

discovered

string

Tylko dane wyjściowe. Określa, czy podczas ostatniego sprawdzania usłudze Hosting udało się znaleźć wymaganą zawartość pliku w podanej ścieżce.

lastCheckTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniego sprawdzenia zawartości pliku przez systemy Hostingu.

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".

checkError

object (Status)

Tylko dane wyjściowe. Podczas ostatniego sprawdzania treści wystąpił błąd. Jeśli ma wartość null, sprawdzanie zostało zakończone.

Metody

create

Tworzy CustomDomain.

delete

Usuwa określoną wartość CustomDomain.

get

Pobiera określoną wartość CustomDomain.

list

Zawiera listę wszystkich elementów CustomDomain powiązanych z określoną nadrzędną witryną Hostingu.

patch

Aktualizuje określoną wartość CustomDomain.

undelete

Przywraca określone CustomDomain, jeśli zostało przeniesione do kosza.