REST Resource: projects.sites.customDomains

Kaynak: CustomDomain

CustomDomain, bir alan adını bir Firebase Hosting sitesine bağlayan tüzel kişidir. Hosting'in, alan adınıza yapılan isteklere yanıt olarak site içeriğini sunmasına izin vermek için sitenize 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 çıkış. CustomDomain öğesinin tam adı.
annotations

map (key: string, value: string)

CustomDomain cihazınızla ilgili olarak hem kullanıcılar hem de makine tarafından okunabilir meta veriler bırakmak için ekleyebileceğiniz notlar.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Yalnızca çıkış. CustomDomain öğesinin en son güncellenme zamanı.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

Yalnızca çıkış. CustomDomain öğesinin silindiği zaman; Silinmemiş özel alanlar için null Silinen özel alanlar yaklaşık 30 gün boyunca saklanır. Bu süre sonunda Hosting bunları tamamen kaldırır. Silinen bir özel alanı yenilemek için customDomains.undelete isteğinde bulunun.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Yalnızca çıkış. Geri yüklenebilir şekilde silinen bir CustomDomain öğesinin, Hosting'den tamamen kaldırılması için geçmesi gereken minimum süre; Silinmemiş özel alanlar için null

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
etag

string

Yalnızca çıkış. CustomDomain öğesinin mevcut durumunu temsil eden ve onu değiştirecek isteklerdeki ilk durumunu onaylamanıza olanak tanıyan bir dize. customDomains.patch, customDomains.delete ve customDomains.undelete istekleri yaparken tutarlılığı sağlamak için bu etiketi kullanın.
hostState

enum (HostState)

Yalnızca çıkış. Bu CustomDomain öğesinin belirttiği alan adının HostState.
ownershipState

enum (OwnershipState)

Yalnızca çıkış. Bu CustomDomain öğesinin belirttiği alan adının OwnershipState.
requiredDnsUpdates

object (DnsUpdates)

Yalnızca çıkış. Hosting'in alan adına güvenli içerik sunmasına izin vermek için alan adının DNS kayıtlarında yapmanız gereken bir dizi güncelleme.
issues[]

object (Status)

Yalnızca çıkış. Hosting sistemlerinin, alan adınız için güvenli içerik sunma yeteneğini oluşturmaya çalışırken karşılaştığı bir dizi hata. CustomDomain cihazınızın doğru şekilde çalışmasını sağlamak için bu sorunları çözün.
certPreference

enum (Type)

Hosting'in alan adınız için oluşturacağı SSL sertifika türünü belirtmenize olanak tanıyan bir alandır. Spark planı özel alanları yalnızca GROUPED sertifika türüne erişebilir. Blaze planı alanları ise herhangi bir seçeneği belirleyebilir.
cert

object (Certificate)

Yalnızca çıkış. Bu özel alanın alan adı için Hosting SSL sertifikasına sahip. Yeni özel alan adlarında bu genellikle gerçek bir sertifika yerine Hosting'in sertifika oluşturma niyetini gösterir. Daha fazlası için state alanını kontrol edin.
redirectTarget

string

Bu CustomDomain öğesinin trafiği yönlendirmesi gereken alan adı. Belirtilirse Hosting bu özel alana yönelik isteklere HTTP 301 koduyla yanıt verir ve trafiği, belirtilen redirectTarget öğesine yönlendirir.
reconciling

boolean

Yalnızca çıkış. Doğru değerine sahipse Hosting sistemlerinin, özel alanın durumunun tercih ettiğiniz durumla eşleşmesini sağlayacak şekilde çalıştığını belirten alan. Bu, genellikle bir customDomains.create isteğinden sonra CustomDomain temel hazırlığı yapılırken veya bir customDomains.patch isteğinden sonra güncellenmiş certPreference ile eşleşecek yeni bir SSL sertifikası oluştururken true olur.
labels

map (key: string, value: string)

Ek meta veri ve/veya filtreleme için kullanılan etiketler.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Ana Makine Eyaleti

Alan adınızın ana makine durumudur. Ana makine durumu, alan adınızla ilişkili her bir IP adresinin, Hosting içeriği sunup sunmadığının kontrol edilmesiyle belirlenir.

Sıralamalar
HOST_STATE_UNSPECIFIED Özel alanınızın ana makine durumu belirtilmedi. Bu belirtilmemişse ileti geçersizdir.
HOST_UNHOSTED Özel alanınızın alan adı, herhangi bir IP adresiyle ilişkilendirilmemiş.
HOST_UNREACHABLE Özel alanınızın alan adına ulaşılamıyor. Barındırma hizmetleri Alan adınızın IP adreslerini bulmaya yönelik DNS sorguları hataya neden olmuştur. Daha fazla ayrıntı için CustomDomain nesnenizin issues alanına bakın.
HOST_MISMATCH Özel alanınızın alan adında, sonunda Hosting'e çözümlenemeyen IP adresleri bulunuyor.
HOST_CONFLICT Özel alanınızın alan adında hem Hosting hem de diğer hizmetlere çözümlenen IP adresleri bulunuyor. Tutarlı sonuçlar elde etmek için barındırma dışı hizmetlerle ilgili A ve AAAA kayıtlarını kaldırın.
HOST_ACTIVE Özel alanınızın alan adına yönelik tüm istekler Hosting tarafından sunulur. Özel alanın OwnershipState değeri de ACTIVE ise Hosting, Hosting sitenizin içeriğini alan adında yayınlar.

Sahiplik Durumu

Alanınızın sahiplik durumu. Bir alan en fazla bir Firebase Barındırma Sitesi'ne ait olabilir. Sahiplik 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, 30 günden uzun süredir OWNERSHIP_ACTIVE dışında bir OwnershipState klasöründeyse ve en az 30 gün içinde güncellenmediyse Hosting'in sahiplik sistemleri CustomDomain öğesini siler. Silinen bir CustomDomain öğesini geri yüklemek için customDomains.undelete isteğinde bulunun.

Sıralamalar
OWNERSHIP_STATE_UNSPECIFIED Özel alanınızın sahiplik durumu belirtilmedi. Böyle bir durum asla olmamalıdır.
OWNERSHIP_MISSING Özel alanınızın alan adında, Hosting ile ilgili sahiplik kaydı yoktur; hiçbir Firebase projesinin alan adı adına işlem yapma izni yok.
OWNERSHIP_UNREACHABLE Özel alanınızın alan adına ulaşılamıyor. Barındırma hizmetleri Alan adınızın sahiplik kayıtlarını bulmaya yönelik DNS sorguları hataya neden olmuştur. Daha fazla ayrıntı için CustomDomain nesnenizin issues alanına bakın.
OWNERSHIP_MISMATCH Özel alanınızın alan adı başka bir Firebase projesine ait. Çakışan TXT kayıtlarını kaldırın ve bunları mevcut Firebase projenizin projeye özel kayıtlarla değiştirin.
OWNERSHIP_CONFLICT Özel alanınızın alan adında, hem mevcut Firebase projenizin hem de başka bir projenin sahibi olduğunuzu gösteren çakışan TXT kayıtları var. Geçerli proje sahipliğini vermek için diğer projenin sahiplik kayıtlarını kaldırın.
OWNERSHIP_PENDING Özel alanınızın DNS kayıtları doğru şekilde yapılandırıldı. Barındırma, alanınızın sahipliğini 24 saat içinde bu CustomDomain adlı kuruluşa aktarır.
OWNERSHIP_ACTIVE Özel alanınızın alan adında, projenize kendi adına işlem yapma izni veren TXT kayıtları var.

DNS Gü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üncellemesidir. Bu güncellemeler, alan adınızın DNS kayıtlarının, Hosting en son sorguladığı andaki mevcut durumunu ve özel alanınızın tam olarak etkin olması için Hosting'in görmesi gereken kayıt grubunu gösterir.

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

object (DnsRecordSet)

Alan incelenirken Barındırma'nın keşfettiği DNS kayıtları kümesi.
desired[]

object (DnsRecordSet)

Hosting DNS kayıtları grubunun alanda güvenli içerik sunması gerekir.
checkTime

string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

DnsRecordSet

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

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

string

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

object (Status)

Yalnızca çıkış. Alan adınızın DNS kayıtları sorgulanırken Barındırma hizmetleri hatasıyla karşılaşıldı. Not: Barındırma, NXDOMAIN hatalarını yok sayar. Bunlar genellikle bir alan adının henüz oluşturulmadığı anlamına gelir.
records[]

object (DnsRecord)

Yalnızca çıkış. Alandaki kayıtlar.

DNS Kaydı

DNS kayıtları, alan adı isteklerini ele alırken 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 sistemleri (ör. kullanıcılarınızın web tarayıcıları) alan adınızla alakalı kaynakları (ör. Hosting sitesi dosyalarınız) almak üzere söz konusu IPv4 adresleriyle iletişime geçmeleri konusunda bilgilendirirsiniz.

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

string

Yalnızca çıkış. Kaydın ait olduğu alan adı, ör. foo.bar.com.
type

enum (Type)

Yalnızca çıkış. Kaydın türü (kayda hangi verilerin yer aldığını belirler).
rdata

string

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

enum (Action)

Yalnızca çıkış. Bu kayıt için gerekli işlemi gösteren bir sıralama.

Tür

DNS kaydının türü (A, TXT, AAAA ve CAA dahil).

Sıralamalar
TYPE_UNSPECIFIED Kayıt türü belirtilmedi. Bu belirtilmemişse ileti geçersizdir.
A RFC 1035'te tanımlandığı gibi bir A kaydı. Kayıtlar, bir alan adının trafiği hangi IPv4 adreslerine yönlendirdiğini belirler.
CNAME RFC 1035'te tanımlandığı gibi bir CNAME kaydı. CNAME veya Kurallı Ad kayıtları, bir alan adını farklı, standart bir alan adıyla eşler. CNAME kaydı varsa alan adındaki tek kayıt bu olmalıdır.
TXT RFC 1035'te tanımlandığı gibi bir TXT kaydı. TXT kayıtları, alan adında rastgele metin verileri içerir. Hosting, hangi Firebase projelerinin 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 hangi IPv6 adreslerine trafik yönlendirdiğini belirler.
CAA

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

CAA kayıtları basamakları. bar.foo.com kendi CAA kaydı kümesine sahip değilse foo.com hizmetindeki CAA kaydı bar.foo.com için de geçerlidir.

CAA kayıtları isteğe bağlıdır. Bir alan adı ve üst öğelerinin CAA kaydı yoksa tüm CA'ların kendi adına sertifika hazırlama yetkisi vardır. Genel olarak, Hosting yalnızca SSL sertifikası oluşturma işleminin engelini kaldırmak için CAA kayıtlarını değiştirmenizi ister.

İşlem

İşlem, alanınızı Firebase Hosting ile kullanmak üzere yapılandırmak için bu DNS kaydında yapmanız gereken bir işlem türüdür.

Sıralamalar
NONE Herhangi bir işlem yapmanız gerekmez.
ADD Bu kaydı DNS kayıtlarınıza ekleyin.
REMOVE Bu kaydı DNS kayıtlarınızdan kaldırın.

Tür

Sertifikanın türü. Hosting sistemlerinin sertifika oluşturma ve yönetme işlemlerini nasıl yapacağını belirler.

Sıralamalar
TYPE_UNSPECIFIED Sertifikanın türü belirtilmedi. Bu belirtilmemişse ileti geçersizdir.
TEMPORARY Bir alan adını geçici olarak kapsayan, Hosting daha kalıcı bir sertifika oluşturan kısa ömürlü bir sertifika türü.
GROUPED Spark planı özel alanları için standart sertifika.
PROJECT_GROUPED Yalnızca Blaze planı. Aynı Firebase projesinde özel alanları içeren 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 istekler için uçtan uca şifreleme sağlamak üzere kullanılan bir SSL sertifikasıdır. Certificate, gerçek bir SSL sertifikası olabilir veya yeni oluşturulan özel alan adları için Hosting'in sertifika oluşturma amacı 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 çıkış. Sertifikanın türü.
state

enum (CertState)

Yalnızca çıkış. Sertifikanın durumu. Alan adı için yalnızca CERT_ACTIVE ve CERT_EXPIRING_SOON durumları SSL kapsamı sağlar. Durum PROPAGATING ise ve Hosting daha önce alan adı için etkin bir sertifikaya sahipse söz konusu eskiden etkin olan sertifika, geçerli sertifika yayılıncaya kadar alan adı için SSL kapsamı sunar.
verification

object (CertVerification)

Yalnızca çıkış. Trafiği barındırmaya yönlendirmeden önce DNS kayıtlarınıza ya da barındırma hizmeti olmayan mevcut barındırma sağlayıcınıza ekleyebileceğiniz bir dizi ACME görevi. Bu zorlukları, eski sağlayıcınızdan Hosting'e sıfır kapalı kalma süresi kapsamında kullanabilirsiniz.
issues[]

object (Status)

Yalnızca çıkış. Hosting'in alan adınız için sertifika oluşturmaya çalışırken karşılaştığı bir dizi hata. Hosting'in, sitenizin ziyaretçileriyle güvenli iletişim kurabildiğinden emin olmak için bu sorunları çözün.
createTime

string (Timestamp format)

Yalnızca çıkış. Sertifikanın oluşturulma zamanı. TEMPORARY sertifikaları için bu, Barındırma'da alan adınız için ilk kez oluşturulan meydan okumadır. Diğer tüm sertifika türlerinde, gerçek sertifikanın oluşturulduğu zamandır.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

Sertifika Durumu

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

Sıralamalar
CERT_STATE_UNSPECIFIED Sertifikanın durumu belirtilmedi. Bu belirtilmemişse ileti geçersizdir.
CERT_PREPARING Her sertifikanın ilk durumu, Hosting'in Sertifika Yetkilisine istek yapılmadan önce sertifika oluşturma niyetini temsil eder.
CERT_VALIDATING Hosting, bir alan adının DNS kayıtlarının, alan adına sertifika oluşturmaya izin veren bir durumda olup olmadığını doğruluyor.
CERT_PROPAGATING Sertifika kısa süre önce oluşturuldu ve Hosting'in CDN'sinde yayılması için zaman gerekiyor.
CERT_ACTIVE Sertifika etkin durumda ve temsil ettiği alan adları için güvenli bağlantılar sağlıyor.
CERT_EXPIRING_SOON Sertifikanın süresi doluyor. Sertifikadaki 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.

SertifikaDoğrulama

Trafiği Hosting sunucularına yönlendirmeden önce, Hosting'in alan adınız için SSL sertifikası oluşturmasına izin vermek amacıyla kullanabileceğiniz ACME sorgulamaları seti. DNS veya HTTP sorgulamasını kullanın; Her ikisini de sağlamanız gerekmez.

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

object (DnsUpdates)

Yalnızca çıkış. DNS kayıtlarınıza eklenecek ve Hosting'in alan adınız için SSL sertifikası oluşturmasına izin vermeyi istediğinizi onaylayan TXT kaydı.
http

object (HttpUpdate)

Yalnızca çıkış. Barındırma dışı mevcut barındırma hizmetinize eklenecek ve Hosting'in alan adınız için SSL sertifikası oluşturmasına izin vermeyi istediğinizi onaylayan dosya.

HttpUpdate

Barındırma dışı mevcut barındırma hizmetinize ekleyebileceğiniz, Hosting'in Sertifika Yetkililerinin alanınız için SSL sertifikası oluşturmasına izin verme isteğinizi onaylayan bir dosya.

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

string

Yalnızca çıkış. Dosyanın yolu.
desired

string

Yalnızca çıkış. Yolda sunulacak bir metin dizesi.
discovered

string

Yalnızca çıkış. Son kontrolü sırasında Hosting'in belirtilen yolda gerekli dosya içeriklerini bulup bulamadığı.
lastCheckTime

string (Timestamp format)

Yalnızca çıkış. Hosting sistemlerinin dosya içeriklerini en son kontrol ettiği zaman.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
checkError

object (Status)

Yalnızca çıkış. Son içerik kontrolü sırasında bir hatayla karşılaşıldı. Null ise kontrol başarıyla tamamlanmıştır.

Yöntemler

create

 CustomDomain oluşturur.

delete

 Belirtilen CustomDomain öğesini siler.

get

 Belirtilen CustomDomain öğesini alır.

list

 Belirtilen üst Hosting sitesiyle ilişkilendirilmiş her bir CustomDomain listesini listeler.

patch

 Belirtilen CustomDomain öğesini günceller.

undelete

 Belirtilen CustomDomain geri yüklenebilir şekilde silindiyse silme işlemini geri alır.