Ressource: CustomDomain
Eine CustomDomain
ist eine Entität, die einen Domänennamen mit einer Firebase-Hosting-Site verknüpft. Fügen Sie Ihrer Website eine CustomDomain
hinzu, damit Hosting den Inhalt der Website als Reaktion auf Anfragen an Ihren Domänennamen bereitstellen kann.
JSON-Darstellung |
---|
{ "name": string, "annotations": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "expireTime": string, "etag": string, "hostState": enum ( |
Felder | |
---|---|
name | Nur Ausgabe. Der vollständig qualifizierte Name der |
annotations | Anmerkungen, die Sie hinzufügen können, um sowohl menschen- als auch maschinenlesbare Metadaten zu Ihrer Ein Objekt, das eine Liste von |
createTime | Nur Ausgabe. Die Erstellungszeit der benutzerdefinierten Domäne. Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
updateTime | Nur Ausgabe. Das letzte Mal, als die Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
deleteTime | Nur Ausgabe. Der Zeitpunkt, zu dem die Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
expireTime | Nur Ausgabe. Die Mindestzeit, bevor eine vorläufig gelöschte Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
etag | Nur Ausgabe. Eine Zeichenfolge, die den aktuellen Status der |
hostState | Nur Ausgabe. Der |
ownershipState | Nur Ausgabe. Der |
requiredDnsUpdates | Nur Ausgabe. Eine Reihe von Aktualisierungen, die Sie an den DNS-Einträgen des Domainnamens vornehmen sollten, damit Hosting in seinem Namen sichere Inhalte bereitstellen kann. |
issues[] | Nur Ausgabe. Eine Reihe von Fehlern, die bei Hosting-Systemen aufgetreten sind, als versucht wurde, die Fähigkeit des Hostings festzustellen, sichere Inhalte für Ihren Domainnamen bereitzustellen. Beheben Sie diese Probleme, um sicherzustellen, dass sich Ihre |
certPreference | Ein Feld, in dem Sie angeben können, welchen SSL-Zertifikattyp Hosting für Ihren Domainnamen erstellt. Benutzerdefinierte Spark-Plan-Domänen haben nur Zugriff auf den Zertifikatstyp |
cert | Nur Ausgabe. Das SSL-Zertifikat, das Hosting für den Domänennamen dieser benutzerdefinierten Domäne hat. Bei neuen benutzerdefinierten Domänen stellt dies häufig die Absicht von Hosting dar, ein Zertifikat und nicht ein tatsächliches Zertifikat zu erstellen. Weitere Informationen finden Sie im |
redirectTarget | Ein Domänenname, zu dem diese |
reconciling | Nur Ausgabe. Ein Feld, das, wenn es wahr ist, angibt, dass die Hosting-Systeme versuchen, den Status der benutzerdefinierten Domain an Ihren bevorzugten Status anzupassen. Dies ist am häufigsten |
labels | Beschriftungen, die für zusätzliche Metadaten und/oder Filterung verwendet werden. Ein Objekt, das eine Liste von |
HostState
Der Hoststatus Ihres Domainnamens. Der Host-Status wird bestimmt, indem jede mit Ihrem Domain-Namen verknüpfte IP-Adresse überprüft wird, um festzustellen, ob sie Hosting-Inhalte bereitstellt.
Aufzählungen | |
---|---|
HOST_STATE_UNSPECIFIED | Der Hoststatus Ihrer benutzerdefinierten Domain ist nicht angegeben. Die Nachricht ist ungültig, wenn dies nicht angegeben ist. |
HOST_UNHOSTED | Der Domänenname Ihrer benutzerdefinierten Domäne ist keinen IP-Adressen zugeordnet. |
HOST_UNREACHABLE | Der Domänenname Ihrer benutzerdefinierten Domäne kann nicht erreicht werden. Die DNS-Abfragen der Hosting-Dienste zur Suche nach den IP-Adressen Ihres Domainnamens führten zu Fehlern. Weitere Einzelheiten finden Sie im issues Ihres CustomDomain Objekts. |
HOST_MISMATCH | Der Domänenname Ihrer benutzerdefinierten Domäne enthält IP-Adressen, die letztendlich nicht in Hosting aufgelöst werden können. |
HOST_CONFLICT | Der Domänenname Ihrer benutzerdefinierten Domäne verfügt über IP-Adressen, die sowohl in Hosting als auch in andere Dienste aufgelöst werden. Um konsistente Ergebnisse sicherzustellen, entfernen Sie A und AAAA Einträge, die sich auf Nicht-Hosting-Dienste beziehen. |
HOST_ACTIVE | Alle Anfragen an den Domainnamen Ihrer benutzerdefinierten Domain werden von Hosting bearbeitet. Wenn der OwnershipState der benutzerdefinierten Domäne ebenfalls ACTIVE ist, stellt Hosting den Inhalt Ihrer Hosting-Site unter dem Domänennamen bereit. |
OwnershipState
Der Eigentumsstatus Ihrer Domain. Eine Domain kann höchstens einer Firebase-Hosting-Site gehören. Das Eigentum kann auf zwei Arten festgestellt werden:
* 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.
Wenn sich Ihre CustomDomain
länger als 30 Tage in einem anderen OwnershipState
als OWNERSHIP_ACTIVE
befindet und seit mindestens 30 Tagen nicht aktualisiert wurde, löschen die Eigentumssysteme von Hosting die CustomDomain
. Um eine gelöschte CustomDomain
wiederherzustellen, stellen Sie eine customDomains.undelete
Anfrage.
Aufzählungen | |
---|---|
OWNERSHIP_STATE_UNSPECIFIED | Der Eigentumsstatus Ihrer benutzerdefinierten Domain ist nicht angegeben. Das sollte niemals passieren. |
OWNERSHIP_MISSING | Der Domainname Ihrer benutzerdefinierten Domain weist keine Hosting-bezogenen Eigentumseinträge auf. Kein Firebase-Projekt hat die Berechtigung, im Namen des Domainnamens zu handeln. |
OWNERSHIP_UNREACHABLE | Der Domänenname Ihrer benutzerdefinierten Domäne kann nicht erreicht werden. Die DNS-Abfragen der Hosting-Dienste zur Suche nach den Eigentumseinträgen Ihres Domainnamens führten zu Fehlern. Weitere Einzelheiten finden Sie im issues Ihres CustomDomain Objekts. |
OWNERSHIP_MISMATCH | Der Domainname Ihrer benutzerdefinierten Domain gehört einem anderen Firebase-Projekt. Entfernen Sie die widersprüchlichen TXT Datensätze und ersetzen Sie sie durch projektspezifische Datensätze für Ihr aktuelles Firebase-Projekt. |
OWNERSHIP_CONFLICT | Der Domainname Ihrer benutzerdefinierten Domain weist widersprüchliche TXT Einträge auf, die darauf hinweisen, dass Ihr aktuelles Firebase-Projekt und ein anderes Projekt Eigentümer sind. Entfernen Sie die Eigentümerdatensätze des anderen Projekts, um dem aktuellen Projekt Eigentümer zu gewähren. |
OWNERSHIP_PENDING | Die DNS-Einträge Ihrer benutzerdefinierten Domäne sind korrekt konfiguriert. Durch das Hosting wird der Besitz Ihrer Domain innerhalb von 24 Stunden auf diese CustomDomain übertragen. |
OWNERSHIP_ACTIVE | Der Domänenname Ihrer benutzerdefinierten Domäne verfügt über TXT Einträge, die dem Projekt die Erlaubnis erteilen, in seinem Namen zu handeln. |
DNS-Updates
Eine Reihe von DNS-Eintragsaktualisierungen, die Sie vornehmen sollten, damit Hosting als Reaktion auf Anfragen an Ihren Domainnamen sichere Inhalte bereitstellen kann. Diese Aktualisierungen zeigen den aktuellen Status der DNS-Einträge Ihres Domänennamens, als Hosting diese zuletzt abgefragt hat, sowie den gewünschten Datensatzsatz, den Hosting sehen muss, bevor Ihre benutzerdefinierte Domäne vollständig aktiv sein kann.
JSON-Darstellung |
---|
{ "discovered": [ { object ( |
Felder | |
---|---|
discovered[] | Der Satz von DNS-Einträgen, die Hosting bei der Überprüfung einer Domain entdeckt hat. |
desired[] | Der Satz von DNS-Einträgen, die das Hosting benötigt, um sichere Inhalte in der Domain bereitzustellen. |
checkTime | Das letzte Mal, als Hosting die DNS-Einträge Ihrer benutzerdefinierten Domain überprüft hat. Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
DnsRecordSet
Eine Reihe von DNS-Einträgen, die für die Einrichtung und Wartung einer benutzerdefinierten Domäne in Firebase Hosting relevant sind.
JSON-Darstellung |
---|
{ "domainName": string, "checkError": { object ( |
Felder | |
---|---|
domainName | Nur Ausgabe. Der Domänenname, zu dem der Datensatz gehört. |
checkError | Nur Ausgabe. Beim Abfragen der DNS-Einträge Ihres Domainnamens ist bei den Hosting-Diensten ein Fehler aufgetreten. Hinweis: Beim Hosting werden |
records[] | Nur Ausgabe. Datensätze auf der Domäne. |
DNSRecord
DNS-Einträge sind Ressourceneinträge, die definieren, wie sich Systeme und Dienste bei der Bearbeitung von Anfragen für einen Domänennamen verhalten sollen. Wenn Sie beispielsweise A
Einträge zu den DNS-Einträgen Ihres Domänennamens hinzufügen, informieren Sie andere Systeme (z. B. die Webbrowser Ihrer Benutzer), diese IPv4-Adressen zu kontaktieren, um für Ihren Domänennamen relevante Ressourcen abzurufen (z. B. Ihre Hosting-Site-Dateien). ).
JSON-Darstellung |
---|
{ "domainName": string, "type": enum ( |
Felder | |
---|---|
domainName | Nur Ausgabe. Der Domänenname, zu dem der Eintrag gehört, z. B. |
type | Nur Ausgabe. Der Typ des Datensatzes, der bestimmt, welche Daten der Datensatz enthält. |
rdata | Nur Ausgabe. Die Daten des Datensatzes. Die Bedeutung des Werts hängt vom Datensatztyp ab: - A und AAAA: IP-Adressen für den Domänennamen. - CNAME: Eine andere Domain, die auf Datensätze überprüft werden soll. - TXT: Beliebige Textzeichenfolgen, die dem Domainnamen zugeordnet sind. Beim Hosting werden TXT-Datensätze verwendet, um zu bestimmen, welche Firebase-Projekte berechtigt sind, im Namen des Domainnamens zu handeln. - CAA: Die Flags, das Tag und der Wert des Datensatzes, z. B. |
requiredAction | Nur Ausgabe. Eine Aufzählung, die die erforderliche Aktion für diesen Datensatz angibt. |
Typ
Der Typ des DNS-Eintrags, einschließlich A
, TXT
, AAAA
und CAA
.
Aufzählungen | |
---|---|
TYPE_UNSPECIFIED | Der Typ des Datensatzes ist nicht angegeben. Die Nachricht ist ungültig, wenn dies nicht angegeben ist. |
A | Ein A Datensatz, wie in RFC 1035 definiert. Ein Datensatz legt fest, an welche IPv4-Adressen ein Domänenname den Datenverkehr weiterleitet. |
CNAME | Ein CNAME Eintrag, wie in RFC 1035 definiert. CNAME oder kanonische Namenseinträge ordnen einen Domänennamen einem anderen kanonischen Domänennamen zu. Wenn ein CNAME Eintrag vorhanden ist, sollte es der einzige Eintrag im Domänennamen sein. |
TXT | Ein TXT Eintrag, wie in RFC 1035 definiert. TXT Einträge enthalten beliebige Textdaten zu einem Domainnamen. Beim Hosting werden TXT Einträge verwendet, um festzustellen, welches Firebase-Projekt berechtigt ist, auf einen Domainnamen zu reagieren. |
AAAA | Ein AAAA-Eintrag gemäß RFC 3596 AAAA-Einträge legen fest, an welche IPv6-Adressen ein Domänenname den Datenverkehr weiterleitet. |
CAA | Ein CAA-Datensatz, wie in RFC 6844 definiert. CAA- oder Certificate Authority Authorization-Datensätze legen fest, welche Zertifizierungsstellen (SSL-Zertifikatsprägeorganisationen) berechtigt sind, ein Zertifikat für den Domänennamen zu erstellen. Firebase Hosting verwendet CAA-Datensatzkaskade. Ein CAA-Eintrag auf CAA-Datensätze sind optional. Wenn ein Domänenname und seine übergeordneten Domänen keine CAA-Einträge haben, sind alle Zertifizierungsstellen berechtigt, in ihrem Namen Zertifikate zu erstellen. Im Allgemeinen fordert Hosting Sie nur dann auf, CAA-Einträge zu ändern, wenn dies erforderlich ist, um die SSL-Zertifikatserstellung freizugeben. |
Aktion
Aktion ist eine Art von Aktion, die Sie für diesen DNS-Eintrag durchführen sollten, um Ihre Domain für die Verwendung mit Firebase Hosting zu konfigurieren.
Aufzählungen | |
---|---|
NONE | Keine Aktion erforderlich. |
ADD | Fügen Sie diesen Eintrag zu Ihren DNS-Einträgen hinzu. |
REMOVE | Entfernen Sie diesen Eintrag aus Ihren DNS-Einträgen. |
Typ
Der Typ des Zertifikats. Bestimmt, wie Hosting-Systeme mit der Erstellung und Verwaltung des Zertifikats umgehen.
Aufzählungen | |
---|---|
TYPE_UNSPECIFIED | Der Typ des Zertifikats ist nicht angegeben. Die Nachricht ist ungültig, wenn dies nicht angegeben ist. |
TEMPORARY | Ein kurzlebiger Zertifikatstyp, der einen Domänennamen vorübergehend abdeckt, während beim Hosting ein dauerhafteres Zertifikat erstellt wird. |
GROUPED | Das Standardzertifikat für benutzerdefinierte Domänen des Spark-Plans. |
PROJECT_GROUPED | Nur Blaze-Plan. Ein Zertifikat, das 1 bis 100 Domänennamen mit benutzerdefinierten Domänen im selben Firebase-Projekt abdeckt. |
DEDICATED | Nur Blaze-Plan. Ein Zertifikat, das einen einzelnen Domänennamen abdeckt. |
Zertifikat
Ein SSL-Zertifikat, das zur Ende-zu-Ende-Verschlüsselung für Anfragen an Ihren Domänennamen dient. Ein Certificate
kann ein tatsächliches SSL-Zertifikat sein oder, bei neu erstellten benutzerdefinierten Domänen, die Absicht des Hostings, eines zu erstellen.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type | Nur Ausgabe. Der Typ des Zertifikats. |
state | Nur Ausgabe. Der Status des Zertifikats. Nur die Zustände |
verification | Nur Ausgabe. Eine Reihe von ACME-Herausforderungen, die Sie zu Ihren DNS-Einträgen oder Ihrem bestehenden Hosting-Anbieter hinzufügen können, der kein Hosting ist, damit Hosting ein SSL-Zertifikat für Ihren Domainnamen erstellen kann, bevor Sie den Datenverkehr auf das Hosting umleiten. Sie können diese Herausforderungen im Rahmen eines Übergangs ohne Ausfallzeiten von Ihrem alten Anbieter zum Hosting nutzen. |
issues[] | Nur Ausgabe. Beim Versuch, ein Zertifikat für Ihren Domainnamen zu erstellen, ist Hosting auf eine Reihe von Fehlern gestoßen. Beheben Sie diese Probleme, um sicherzustellen, dass Hosting eine sichere Kommunikation mit den Besuchern Ihrer Website ermöglichen kann. |
createTime | Nur Ausgabe. Die Erstellungszeit des Zertifikats. Bei Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
expireTime | Nur Ausgabe. Die Ablaufzeit des Zertifikats. Nach dieser Zeit kann das Zertifikat nicht mehr für die sichere Kommunikation zwischen Hosting und den Besuchern Ihrer Website verwendet werden. Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
CertState
Der Status des SSL-Zertifikats, das Hosting für Ihren Domainnamen hat. Dies kann entweder den Status des tatsächlichen Zertifikats oder, bei neuen benutzerdefinierten Domänen, den Versuch von Hosting darstellen, ein Zertifikat zu erstellen.
Aufzählungen | |
---|---|
CERT_STATE_UNSPECIFIED | Der Status des Zertifikats ist nicht angegeben. Die Nachricht ist ungültig, wenn dies nicht angegeben ist. |
CERT_PREPARING | Der Anfangszustand jedes Zertifikats stellt die Absicht des Hostings dar, ein Zertifikat zu erstellen, bevor Anfragen an eine Zertifizierungsstelle gestellt werden. |
CERT_VALIDATING | Beim Hosting wird überprüft, ob sich die DNS-Einträge eines Domänennamens in einem Zustand befinden, der die Erstellung eines Zertifikats in seinem Namen zulässt. |
CERT_PROPAGATING | Das Zertifikat wurde kürzlich erstellt und benötigt Zeit, um sich im CDN von Hosting zu verbreiten. |
CERT_ACTIVE | Das Zertifikat ist aktiv und stellt sichere Verbindungen für die Domänennamen bereit, die es repräsentiert. |
CERT_EXPIRING_SOON | Das Zertifikat läuft ab, alle darauf befindlichen Domainnamen erhalten neue Zertifikate. |
CERT_EXPIRED | Das Zertifikat ist abgelaufen. Beim Hosting können auf Ihrem Domainnamen keine sicheren Inhalte mehr bereitgestellt werden. |
Zertifikatsüberprüfung
Eine Reihe von ACME-Herausforderungen, mit denen Sie Hosting die Erstellung eines SSL-Zertifikats für Ihren Domainnamen ermöglichen können, bevor der Datenverkehr an Hosting-Server weitergeleitet wird. Verwenden Sie entweder die DNS- oder HTTP-Challenge; Es ist nicht notwendig, beides bereitzustellen.
JSON-Darstellung |
---|
{ "dns": { object ( |
Felder | |
---|---|
dns | Nur Ausgabe. Ein |
http | Nur Ausgabe. Eine Datei, die Sie zu Ihrem bestehenden, nicht von Hosting stammenden Hosting-Service hinzufügen können und die Ihre Absicht bestätigt, Hosting ein SSL-Zertifikat für Ihren Domainnamen erstellen zu lassen. |
HttpUpdate
Eine Datei, die Sie zu Ihrem bestehenden, nicht von Hosting stammenden Hosting-Dienst hinzufügen können und die Ihre Absicht bestätigt, den Zertifizierungsstellen von Hosting die Erstellung eines SSL-Zertifikats für Ihre Domain zu gestatten.
JSON-Darstellung |
---|
{
"path": string,
"desired": string,
"discovered": string,
"lastCheckTime": string,
"checkError": {
object ( |
Felder | |
---|---|
path | Nur Ausgabe. Der Pfad zur Datei. |
desired | Nur Ausgabe. Eine Textzeichenfolge, die am Pfad bereitgestellt werden soll. |
discovered | Nur Ausgabe. Ob Hosting bei seiner letzten Prüfung den benötigten Dateiinhalt im angegebenen Pfad finden konnte. |
lastCheckTime | Nur Ausgabe. Das letzte Mal, dass Hosting-Systeme den Dateiinhalt überprüft haben. Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
checkError | Nur Ausgabe. Bei der letzten Inhaltsprüfung ist ein Fehler aufgetreten. Wenn null, wurde die Prüfung erfolgreich abgeschlossen. |
Methoden | |
---|---|
| Erstellt eine CustomDomain . |
| Löscht die angegebene CustomDomain . |
| Ruft die angegebene CustomDomain ab. |
| Listet alle CustomDomain auf, die mit der angegebenen übergeordneten Hosting-Site verknüpft sind. |
| Aktualisiert die angegebene CustomDomain . |
| Stellt die angegebene CustomDomain wieder her, wenn sie vorläufig gelöscht wurde. |