REST Resource: projects.sites.customDomains

Kaynak: Özel Etki Alanı

CustomDomain bir alan adını Firebase Barındırma sitesine bağlayan bir varlıktır. Hosting'in alan adınıza yönelik isteklere yanıt olarak site içeriğini sunmasına izin vermek için sitenize bir CustomDomain ekleyin.

JSON gösterimi
{
  "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,
    ...
  }
}
Alanlar
name

string

Yalnızca çıktı. CustomDomain tam nitelikli adı.

annotations

map (key: string, value: string)

CustomDomain hakkında hem insan hem de makine tarafından okunabilir meta veriler bırakmak için ek açıklamalar ekleyebilirsiniz.

"key": value çiftleri. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Yalnızca çıktı. Özel alan adının oluşturulma zamanı.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Yalnızca çıktı. CustomDomain en son güncellendiği zaman.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

deleteTime

string ( Timestamp format)

Yalnızca çıktı. CustomDomain silindiği zaman; Silinmemiş özel alanlar için null. Silinen özel alan adları yaklaşık 30 gün boyunca kalır ve bu sürenin sonunda Hosting bunları tamamen kaldırır. Silinen bir özel etki alanını geri yüklemek için customDomains.undelete isteğinde bulunun.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

expireTime

string ( Timestamp format)

Yalnızca çıktı. Geçici olarak silinen bir CustomDomain Hosting'den tamamen kaldırılmasından önceki minimum süre; Silinmemiş özel alanlar için null.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

etag

string

Yalnızca çıktı. CustomDomain geçerli durumunu temsil eden ve onu değiştirecek isteklerde başlangıç ​​durumunu onaylamanıza olanak tanıyan bir dize. customDomains.patch , customDomains.delete ve customDomains.undelete istekleri yaparken tutarlılığı sağlamak için etiketi kullanın.

hostState

enum ( HostState )

Yalnızca çıktı. Bu CustomDomain başvurduğu alan adının HostState .

ownershipState

enum ( OwnershipState )

Yalnızca çıktı. Bu CustomDomain başvurduğu alan adının OwnershipState .

requiredDnsUpdates

object ( DnsUpdates )

Yalnızca çıktı. Hosting'in kendi adına güvenli içerik sunabilmesi için alan adının DNS kayıtlarında yapmanız gereken bir dizi güncelleme.

issues[]

object ( Status )

Yalnızca çıktı. Hosting sistemlerinin alan adınız için güvenli içerik sunma yeteneğini belirlemeye çalışırken Hosting sistemlerinin karşılaştığı bir dizi hata. CustomDomain düzgün çalıştığından emin olmak için bu sorunları çözün.

certPreference

enum ( Type )

Hosting'in alan adınız için hangi SSL sertifika türünü oluşturacağını belirtmenizi sağlayan alan. Spark planı özel alan adları yalnızca GROUPED sertifika türüne erişime sahipken Blaze planı alan adları herhangi bir seçeneği belirleyebilir.

cert

object ( Certificate )

Yalnızca çıktı. Hosting'in bu özel alan adının alan adı için sahip olduğu SSL sertifikası. Yeni özel alan adları için bu genellikle Hosting'in gerçek bir sertifika yerine sertifika oluşturma niyetini temsil eder. Daha fazla bilgi için state alanını kontrol edin.

redirectTarget

string

Bu CustomDomain trafiği yönlendirmesi gereken alan adı. Belirtilmişse Hosting, bu özel etki alanına yönelik isteklere bir HTTP 301 koduyla yanıt verir ve bunun yerine trafiği belirtilen redirectTarget yönlendirir.

reconciling

boolean

Yalnızca çıktı. Doğruysa, Hosting sistemlerinin özel alan adının durumunu tercih ettiğiniz durumla eşleştirmeye çalıştığını gösteren bir alan. Bu, çoğunlukla bir customDomains.create isteğinin ardından ilk olarak bir CustomDomain hazırlarken veya bir customDomains.patch isteğinden sonra güncellenmiş bir certPreference ile eşleşecek yeni bir SSL sertifikası oluştururken true .

labels

map (key: string, value: string)

Ekstra meta veriler ve/veya filtreleme için kullanılan etiketler.

"key": value çiftleri. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Ana Bilgisayar Durumu

Alan adınızın ana bilgisayar durumu. Ana makine durumu, alan adınızla ilişkili her bir IP adresinin Barındırma içeriği sunup sunmadığını kontrol ederek belirlenir.

Numaralandırmalar
HOST_STATE_UNSPECIFIED Özel alan adınızın ana makine durumu belirtilmemiş. Bu belirtilmezse mesaj geçersizdir.
HOST_UNHOSTED Özel alan adınızın alan adı herhangi bir IP adresiyle ilişkili değildir.
HOST_UNREACHABLE Özel alan adınızın alan adına ulaşılamıyor. Hosting hizmetlerinin alan adınızın IP adreslerini bulmak için yaptığı DNS sorguları hatalarla sonuçlandı. Daha fazla ayrıntı için CustomDomain nesnenizin issues alanına bakın.
HOST_MISMATCH Özel alan adınızın alan adı, sonuçta Barındırma'ya çözümlenmeyen IP adreslerine sahiptir.
HOST_CONFLICT Özel alan adınızın alan adı, hem Barındırma hem de diğer hizmetlere çözümlenen IP adreslerine sahiptir. Tutarlı sonuçlar elde etmek için Hosting dışı hizmetlerle ilgili A ve AAAA kayıtlarını kaldırın.
HOST_ACTIVE Özel alan adınızın alan adına yönelik tüm istekler Hosting tarafından karşılanır. Özel alan adının OwnershipState değeri de ACTIVE ise Hosting, Hosting sitenizin içeriğini alan adı üzerinde sunar.

Mülkiyet Durumu

Alan adınızın sahiplik durumu. Bir alan adı en fazla bir Firebase Hosting Sitesine ait olabilir. Mülkiyet iki şekilde belirlenebilir:

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

CustomDomain OWNERSHIP_ACTIVE dışında bir OwnershipState 30 günden fazla bir süre boyunca bulunuyorsa ve en az 30 gün içinde güncellenmediyse Hosting'in sahiplik sistemleri CustomDomain siler. Silinen bir CustomDomain dosyasını geri yüklemek için customDomains.undelete isteğinde bulunun.

Numaralandırmalar
OWNERSHIP_STATE_UNSPECIFIED Özel alan adınızın sahiplik durumu belirtilmedi. Bu asla olmamalı.
OWNERSHIP_MISSING Özel alan adınızın alan adında Hosting ile ilgili sahiplik kaydı yoktur; hiçbir Firebase projesinin alan adı adına hareket etme izni yoktur.
OWNERSHIP_UNREACHABLE Özel alan adınızın alan adına ulaşılamıyor. Hosting hizmetlerinin alan adınızın sahiplik kayıtlarını bulmak için yaptığı DNS sorguları hatalarla sonuçlandı. Daha fazla ayrıntı için CustomDomain nesnenizin issues alanına bakın.
OWNERSHIP_MISMATCH Özel alan adınızın alan adı başka bir Firebase projesine ait. Çakışan TXT kayıtlarını kaldırın ve bunları mevcut Firebase projeniz için projeye özel kayıtlarla değiştirin.
OWNERSHIP_CONFLICT Özel alan adınızın alan adı, hem mevcut Firebase projenizin hem de başka bir projenin sahibi olduğunuzu gösteren çakışan TXT kayıtları içeriyor. Mevcut proje sahipliğini vermek için diğer projenin sahiplik kayıtlarını kaldırın.
OWNERSHIP_PENDING Özel alan adınızın DNS kayıtları doğru şekilde yapılandırılmıştır. Barındırma, alan adınızın sahipliğini 24 saat içinde bu CustomDomain aktaracaktır.
OWNERSHIP_ACTIVE Özel alan adınızın alan adı, projesine kendi adına hareket etme izni veren TXT kayıtlarına sahiptir.

DnsGüncellemeleri

Hosting'in alan adınıza yönelik isteklere yanıt olarak güvenli içerik sunmasına izin vermek için yapmanız gereken bir dizi DNS kaydı güncellemesi. Bu güncellemeler, Hosting'in bunları en son sorguladığı sırada alan adınızın DNS kayıtlarının mevcut durumunu ve özel alan adınızın tamamen aktif olabilmesi için Hosting'in görmesi gereken istenen kayıt kümesini sunar.

JSON gösterimi
{
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
Alanlar
discovered[]

object ( DnsRecordSet )

Hosting'in bir alanı incelerken keşfettiği DNS kayıtları kümesi.

desired[]

object ( DnsRecordSet )

Hosting'in etki alanında güvenli içerik sunması gereken DNS kayıtları kümesi.

checkTime

string ( Timestamp format)

Hosting, özel alan adınızın DNS kayıtlarını en son kontrol ettiğinde.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

DnsRecordSet

Firebase Hosting'de özel bir alan adının kurulumu ve bakımıyla ilgili bir dizi DNS kaydı.

JSON gösterimi
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
Alanlar
domainName

string

Yalnızca çıktı. Kayıt kümesinin ait olduğu alan adı.

checkError

object ( Status )

Yalnızca çıktı. Alan adınızın DNS kayıtları sorgulanırken Hosting hizmetlerinde karşılaşılan bir hata. Not: Barındırma, NXDOMAIN hatalarını yok sayar; çünkü bunlar genellikle bir alan adının henüz kurulmadığı anlamına gelir.

records[]

object ( DnsRecord )

Yalnızca çıktı. Etki alanındaki kayıtlar.

DNS Kaydı

DNS kayıtları, bir alan adı için istekleri işlerken sistemlerin ve hizmetlerin nasıl davranması gerektiğini tanımlayan kaynak kayıtlarıdır. Örneğin, alan adınızın DNS kayıtlarına A kayıtları eklediğinizde, diğer sistemlere (kullanıcılarınızın web tarayıcıları gibi), alan adınızla ilgili kaynakları (Barındırma sitesi dosyalarınız gibi) almak için bu IPv4 adresleriyle iletişim kurmaları konusunda bilgi vermiş olursunuz. ).

JSON gösterimi
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action)
}
Alanlar
domainName

string

Yalnızca çıktı. Kaydın ait olduğu alan adı, örneğin foo.bar.com. .

type

enum ( Type )

Yalnızca çıktı. Kaydın hangi verileri içerdiğini belirleyen kayıt türü.

rdata

string

Yalnızca çıktı. Kaydın verileri. Değerin anlamı kayıt türüne bağlıdır: - A ve AAAA: Alan adı için IP adresleri. - CNAME: Kayıtların kontrol edileceği başka bir alan adı. - TXT: Alan adıyla ilişkili rastgele metin dizeleri. Barındırma, hangi Firebase projelerinin alan adı adına hareket etme iznine sahip olduğunu belirlemek için TXT kayıtlarını kullanır. - CAA: Kaydın bayrakları, etiketi ve değeri, örneğin 0 issue "pki.goog" .

requiredAction

enum ( Action )

Yalnızca çıktı. Bu kayıt için gerekli eylemi gösteren bir numaralandırma.

Tip

A , TXT , AAAA ve CAA dahil olmak üzere DNS kaydının türü.

Numaralandırmalar
TYPE_UNSPECIFIED Kaydın türü belirtilmedi. Bu belirtilmezse mesaj geçersizdir.
A RFC 1035'te tanımlandığı gibi bir A kaydı. Bir kayıt, bir alan adının trafiği hangi IPv4 adresine yönlendirdiğini belirler.
CNAME RFC 1035'te tanımlandığı gibi bir CNAME kaydı. CNAME veya Kanonik Ad kayıtları, bir alan adını farklı, kanonik bir alan adıyla eşler. Bir CNAME kaydı mevcutsa, alan adındaki tek kayıt bu olmalıdır.
TXT RFC 1035'te tanımlandığı gibi bir TXT kaydı. TXT kayıtları bir alan adı üzerinde rastgele metin verileri tutar. Barındırma, hangi Firebase Projesinin bir alan adı üzerinde işlem yapma iznine sahip olduğunu belirlemek için TXT kayıtlarını kullanır.
AAAA RFC 3596 AAAA kayıtlarında tanımlandığı gibi bir AAAA kaydı, bir alan adının trafiği hangi IPv6 adresine yönlendirdiğini belirler.
CAA

RFC 6844'te tanımlandığı gibi bir CAA kaydı. CAA veya Sertifika Yetkilisi Yetkilendirmesi kayıtları, hangi Sertifika Yetkililerinin (SSL sertifika basan kuruluşlar) alan adı için bir sertifika basmaya yetkili olduğunu belirler. Firebase Hosting, birincil CA'sı olarak pki.goog kullanır.

CAA kayıtları kademeli. foo.com bir CAA kaydı, bar.foo.com kendi CAA kayıtları dizisi olmadığı sürece bar.foo.com için de geçerlidir.

CAA kayıtları isteğe bağlıdır. Bir alan adının ve üst öğelerinin CAA kaydı yoksa, tüm CA'lar onun adına sertifika basmaya yetkilidir. Genel olarak Hosting sizden yalnızca SSL sertifikası oluşturma engelini kaldırmak için gerekli olduğunda CAA kayıtlarını değiştirmenizi ister.

Aksiyon

Eylem, alanınızı Firebase Hosting ile kullanılacak şekilde yapılandırmak için bu DNS kaydında gerçekleştirmeniz gereken bir eylem türüdür.

Numaralandırmalar
NONE Herhangi bir eyleme gerek yok.
ADD Bu kaydı DNS kayıtlarınıza ekleyin.
REMOVE Bu kaydı DNS kayıtlarınızdan kaldırın.

Tip

Sertifikanın türü. Barındırma sistemlerinin sertifikayı nasıl oluşturup sürdüreceğini belirler.

Numaralandırmalar
TYPE_UNSPECIFIED Sertifikanın türü belirtilmedi. Bu belirtilmezse mesaj geçersizdir.
TEMPORARY Bir alan adını geçici olarak kapsayan, kısa ömürlü bir sertifika türü olan Hosting ise daha kalıcı bir sertifika oluşturur.
GROUPED Spark planı özel alan adları için standart sertifika.
PROJECT_GROUPED Yalnızca Blaze planı. Aynı Firebase projesinde özel alan adlarına sahip 1 ila 100 alan adını kapsayan bir sertifika.
DEDICATED Yalnızca Blaze planı. Tek bir alan adını kapsayan sertifika.

Sertifika

Alan adınıza yönelik isteklerde uçtan uca şifreleme sağlamak için kullanılan bir SSL sertifikası. Certificate gerçek bir SSL sertifikası veya yeni oluşturulan özel alanlar için Hosting'in bir sertifika oluşturma niyeti olabilir.

JSON gösterimi
{
  "type": enum (Type),
  "state": enum (CertState),
  "verification": {
    object (CertVerification)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "createTime": string,
  "expireTime": string
}
Alanlar
type

enum ( Type )

Yalnızca çıktı. Sertifikanın türü.

state

enum ( CertState )

Yalnızca çıktı. Sertifikanın durumu. Yalnızca CERT_ACTIVE ve CERT_EXPIRING_SOON durumları bir alan adı için SSL kapsamı sağlar. Durum PROPAGATING ise ve Hosting, alan adı için daha önce etkin bir sertifikaya sahipse, önceden etkin olan bu sertifika, geçerli sertifika yayılana kadar alan adı için SSL kapsamı sağlar.

verification

object ( CertVerification )

Yalnızca çıktı. Trafiği barındırmaya yönlendirmeden önce Hosting'in alan adınız için bir SSL sertifikası oluşturmasına izin vermek amacıyla DNS kayıtlarınıza veya mevcut, Hosting olmayan barındırma sağlayıcınıza ekleyebileceğiniz bir dizi ACME sorgulaması. Bu zorlukları, eski sağlayıcınızdan Hosting'e sıfır kesinti süresiyle geçişin bir parçası olarak kullanabilirsiniz.

issues[]

object ( Status )

Yalnızca çıktı. Alan adınız için bir sertifika oluşturmaya çalışırken Hosting'in karşılaştığı bir dizi hata. Hosting'in sitenizin ziyaretçileriyle güvenli iletişim sağlayabilmesini sağlamak için bu sorunları çözün.

createTime

string ( Timestamp format)

Yalnızca çıktı. Sertifikanın oluşturulma zamanı. TEMPORARY sertifikalar için bu, Hosting'in alan adınız için ilk kez zorluklar oluşturduğu zamandır. Diğer tüm sertifika türleri için bu, gerçek sertifikanın oluşturulduğu zamandır.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

expireTime

string ( Timestamp format)

Yalnızca çıktı. Sertifikanın geçerlilik süresi. Bu sürenin sonunda sertifika, Hosting ile sitenizin ziyaretçileri arasında güvenli iletişim sağlamak için artık kullanılamaz.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

Sertifika Durumu

Hosting'in alan adınız için sahip olduğu SSL sertifikasının durumu. Bu, gerçek sertifikanın durumunu veya yeni özel alanlar için Hosting'in sertifika oluşturma girişimini temsil edebilir.

Numaralandırmalar
CERT_STATE_UNSPECIFIED Sertifikanın durumu belirtilmedi. Bu belirtilmezse mesaj geçersizdir.
CERT_PREPARING Her sertifikanın başlangıç ​​durumu, Sertifika Yetkilisine talepte bulunulmadan önce Hosting'in sertifika oluşturma niyetini temsil eder.
CERT_VALIDATING Barındırma, bir alan adının DNS kayıtlarının, kendisi adına sertifika oluşturulmasına izin verecek durumda olup olmadığının doğrulanmasıdır.
CERT_PROPAGATING Sertifika yakın zamanda oluşturuldu ve Hosting'in CDN'sinde yayılması zaman alıyor.
CERT_ACTIVE Sertifika etkindir ve temsil ettiği alan adları için güvenli bağlantılar sağlar.
CERT_EXPIRING_SOON Sertifikanın süresi doluyor, üzerindeki tüm alan adlarına yeni sertifika verilecek.
CERT_EXPIRED Sertifikanın süresi doldu. Hosting artık alan adınızda güvenli içerik sunamaz.

Sertifika Doğrulaması

Trafiği Hosting sunucularına yönlendirmeden önce Hosting'in alan adınız için bir SSL sertifikası oluşturmasına izin vermek için kullanabileceğiniz bir dizi ACME sorgulaması. DNS veya HTTP sınamasını kullanın; her ikisini de sağlamak gerekli değildir.

JSON gösterimi
{
  "dns": {
    object (DnsUpdates)
  },
  "http": {
    object (HttpUpdate)
  }
}
Alanlar
dns

object ( DnsUpdates )

Yalnızca çıktı. Hosting'in alan adınız için bir SSL sertifikası oluşturmasına izin verme niyetinizi doğrulayan, DNS kayıtlarınıza eklenecek bir TXT kaydı.

http

object ( HttpUpdate )

Yalnızca çıktı. Hosting'in alan adınız için bir SSL sertifikası oluşturmasına izin verme niyetinizi onaylayan, mevcut Hosting dışı barındırma hizmetinize eklenecek bir dosya.

HttpGüncelleme

Mevcut Hosting dışı barındırma hizmetinize ekleyebileceğiniz, Hosting Sertifika Yetkililerinin alan adınız için bir SSL sertifikası oluşturmasına izin verme niyetinizi doğrulayan bir dosya.

JSON gösterimi
{
  "path": string,
  "desired": string,
  "discovered": string,
  "lastCheckTime": string,
  "checkError": {
    object (Status)
  }
}
Alanlar
path

string

Yalnızca çıktı. Dosyanın yolu.

desired

string

Yalnızca çıktı. Yolda sunulacak bir metin dizesi.

discovered

string

Yalnızca çıktı. Hosting'in son kontrolü sırasında gerekli dosya içeriğini belirtilen yolda bulup bulamadığı.

lastCheckTime

string ( Timestamp format)

Yalnızca çıktı. Hosting sistemleri dosya içeriğini en son kontrol ettiğinde.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z" .

checkError

object ( Status )

Yalnızca çıktı. Son içerik kontrolü sırasında bir hatayla karşılaşıldı. Boşsa, kontrol başarıyla tamamlandı.

Yöntemler

create

 Bir CustomDomain oluşturur.

delete

 Belirtilen CustomDomain öğesini siler.

get

 Belirtilen CustomDomain alır.

list

 Belirtilen üst Barındırma sitesiyle ilişkili her CustomDomain listeler.

patch

 Belirtilen CustomDomain öğesini günceller.

undelete

 Geçici olarak silinmişse, belirtilen CustomDomain silinmesini geri alır.