REST Resource: projects.locations.backends.domains

Resource: Domain

Nama domain yang dikaitkan dengan backend.

Representasi 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
}
Kolom
name

string

ID. Nama resource domain, mis. /projects/p/locations/l/backends/b/domains/foo.com
displayName

string

Opsional. Nama domain yang dapat diubah dan dapat dibaca. Maksimal 63 karakter. mis. prod domain.
createTime

string (Timestamp format)

Hanya output. Waktu saat domain dibuat.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Hanya output. Waktu saat domain terakhir diperbarui.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
type

enum (Type)

Hanya output. Jenis domain.
disabled

boolean

Opsional. Apakah domain dinonaktifkan. Nilai defaultnya adalah false (salah).
serve

object (ServingBehavior)

Opsional. Perilaku penayangan domain. Jika ditentukan, domain akan menayangkan konten selain konten aktif backend-nya.
customDomainStatus

object (CustomDomainStatus)

Hanya output. Merepresentasikan status dan konfigurasi domain jenis CUSTOM. Ini hanya ada di Domain jenis tersebut.
reconciling

boolean

Hanya output. Kolom yang, jika benar, menunjukkan bahwa build memiliki LRO yang sedang berlangsung.
deleteTime

string (Timestamp format)

Hanya output. Waktu saat domain dihapus.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
purgeTime

string (Timestamp format)

Hanya output. Waktu saat domain yang dihapus untuk sementara akan dihapus, sehingga proses rendering dihapus secara permanen.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Opsional. Label sebagai pasangan nilai kunci.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Opsional. Anotasi sebagai pasangan nilai kunci.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Hanya output. ID unik yang ditetapkan oleh sistem.
etag

string

Hanya output. Checksum yang dihitung oleh server berdasarkan nilai lain; mungkin dikirim saat pembaruan atau penghapusan untuk memastikan operasi dilakukan pada resource yang diharapkan.

Jenis

Jenis domain.

Enum
TYPE_UNSPECIFIED Jenisnya tidak ditentukan (hal ini seharusnya tidak terjadi).
DEFAULT Default, domain yang disediakan dan dikelola oleh Hosting Aplikasi. Domain ini dibuat secara otomatis dengan backend induknya dan tidak dapat dihapus kecuali dengan menghapus induk tersebut, dan tidak dapat dipindahkan ke backend lain. Domain default dapat dinonaktifkan melalui kolom disabled.
CUSTOM Domain kustom milik developer. Dengan Domain Kustom, Anda dapat mengaitkan domain yang Anda miliki dengan backend App Hosting, dan mengonfigurasi domain tersebut untuk menayangkan konten backend Anda.

Perilaku Penayangan

Menunjukkan apakah App Hosting akan menayangkan konten di domain.

Representasi 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.
}
Kolom
Kolom union serving_behavior. Jika ditentukan, akan menyesuaikan perilaku penayangan domain. serving_behavior hanya ada berupa salah satu diantara berikut:
redirect

object (Redirect)

Opsional. Perilaku pengalihan untuk domain, jika disediakan.

Pengalihan

Menentukan perilaku pengalihan untuk domain.

Representasi JSON 
{
  "uri": string,
  "status": string
}
Kolom
uri

string

Wajib diisi. URI tujuan yang dimaksudkan untuk pengalihan. URI ini akan ditambahkan ke jalur permintaan asli. URI tanpa skema dianggap sebagai HTTPS.
status

string (int64 format)

Opsional. Kode status yang akan digunakan dalam respons pengalihan. Harus berupa kode status HTTP 3XX yang valid. Jika tidak ada, defaultnya adalah 302.

StatusDomainKustom

Status penautan domain kustom ke backend.

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

enum (HostState)

Hanya output. Melacak apakah domain kustom terdeteksi sebagai mengarahkan traffic ke App Hosting dengan tepat.
ownershipState

enum (OwnershipState)

Hanya output. Melacak apakah backend diizinkan untuk menyajikan konten di domain, berdasarkan data DNS domain.
certState

enum (CertState)

Hanya output. Melacak status sertifikat SSL untuk domain.
requiredDnsUpdates[]

object (DnsUpdates)

Hanya output. Mencantumkan data yang harus ditambahkan atau dihapus ke DNS domain kustom untuk menyelesaikan penyiapan dan mulai menayangkan konten. Kolom ada selama orientasi. Juga ada setelah orientasi jika satu atau beberapa status di atas tidak *_ACTIVE, yang menunjukkan data DNS domain dalam kondisi buruk.
issues[]

object (Status)

Hanya output. Daftar masalah terkait konfigurasi domain. Memungkinkan pengguna mengoreksi sendiri masalah terkait data DNS.

HostState

Status host domain Anda. Status host ditentukan dengan memeriksa setiap alamat IP yang terkait dengan domain Anda untuk melihat apakah penayangan ditayangkan melalui shard yang sesuai dengan Asal Hosting Aplikasi.

Enum
HOST_STATE_UNSPECIFIED Status host domain kustom Anda tidak ditentukan. Pesan tidak valid jika tidak ditentukan.
HOST_UNHOSTED Domain kustom Anda tidak terkait dengan alamat IP mana pun.
HOST_UNREACHABLE Domain kustom tidak dapat dijangkau. Layanan Hosting Aplikasi Kueri DNS untuk menemukan alamat IP domain Anda menghasilkan error. Lihat kolom issues CustomDomainStatus untuk detail selengkapnya.
HOST_NON_FAH Domain Anda hanya memiliki alamat IP yang pada akhirnya tidak ditetapkan ke App Hosting.
HOST_CONFLICT Domain Anda memiliki alamat IP yang ditetapkan ke App Hosting dan ke layanan lainnya. Untuk memastikan hasil yang konsisten, hapus data A dan AAAA yang terkait dengan layanan non-Hosting Aplikasi.
HOST_WRONG_SHARD Domain Anda memiliki alamat IP yang ditetapkan ke region dan/atau shard replikasi yang salah dari App Hosting.
HOST_ACTIVE Semua permintaan terhadap domain Anda dilayani oleh App Hosting, melalui shard yang ditetapkan domain Anda. Jika OwnershipState domain kustom juga bernilai OWNERSHIP_ACTIVE, App Hosting akan menayangkan konten backend-nya berdasarkan permintaan untuk domain tersebut.

Status Kepemilikan

Status kepemilikan domain kustom Anda.

Enum
OWNERSHIP_STATE_UNSPECIFIED Status kepemilikan domain kustom Anda tidak ditentukan. Hal ini tidak boleh terjadi.
OWNERSHIP_MISSING Domain domain kustom Anda tidak memiliki data kepemilikan terkait Hosting Aplikasi; tidak ada backend yang diizinkan untuk ditayangkan di domain dalam shard Asal ini.
OWNERSHIP_UNREACHABLE Domain kustom tidak dapat dijangkau. Layanan Hosting Aplikasi Kueri DNS untuk menemukan data kepemilikan domain Anda menghasilkan error. Lihat kolom issues CustomDomainStatus untuk detail selengkapnya.
OWNERSHIP_MISMATCH Domain kustom Anda dimiliki oleh domain kustom Hosting Aplikasi lain. Hapus data yang bentrok dan ganti dengan data untuk domain kustom Anda saat ini.
OWNERSHIP_CONFLICT Domain kustom Anda memiliki data TXT yang bertentangan, yang menunjukkan kepemilikan oleh satu atau beberapa domain kustom Anda saat ini. Hapus data kepemilikan yang tidak relevan untuk memberikan kepemilikan domain kustom saat ini.
OWNERSHIP_PENDING Data DNS domain kustom Anda dikonfigurasi dengan benar. App Hosting akan mentransfer kepemilikan domain Anda ke domain kustom ini dalam waktu 24 jam.
OWNERSHIP_ACTIVE Domain kustom Anda adalah pemilik domain.

Sertifikasi

Status sertifikat SSL yang dimiliki App Hosting untuk nama domain Anda. Ini bisa mewakili status sertifikat sebenarnya atau, untuk domain kustom baru, upaya yang sedang berlangsung oleh App Hosting untuk membuat sertifikat.

Enum
CERT_STATE_UNSPECIFIED Status sertifikat tidak ditentukan. Pesan tidak valid jika tidak ditentukan.
CERT_PREPARING Status awal setiap sertifikat, menunjukkan maksud App Hosting untuk membuat sertifikat sebelum permintaan ke Certificate Authority dibuat.
CERT_VALIDATING App Hosting memvalidasi apakah data DNS nama domain berada dalam status yang memungkinkan pembuatan sertifikat atas namanya.
CERT_PROPAGATING Sertifikat baru saja dibuat, dan memerlukan waktu untuk diterapkan di load balancer App Hosting.
CERT_ACTIVE Sertifikat aktif, menyediakan koneksi aman untuk nama domain yang diwakilinya.
CERT_EXPIRING_SOON Masa berlaku sertifikat akan berakhir, semua nama domain di dalamnya akan diberi sertifikat baru.
CERT_EXPIRED Sertifikat sudah tidak berlaku. App Hosting tidak dapat lagi menayangkan konten yang aman pada nama domain Anda.

Update Dns

Kumpulan pembaruan data DNS yang harus Anda lakukan agar App Hosting dapat menayangkan konten aman sebagai respons terhadap permintaan terhadap domain Anda. Pembaruan ini menyajikan status terkini dari domain Anda dan subdomain terkait Data DNS saat App Hosting terakhir kali mengkuerinya, dan kumpulan data yang diinginkan dan perlu dilihat oleh App Hosting sebelum domain kustom Anda dapat aktif sepenuhnya.

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

string

Hanya output. Nama domain yang terkait dengan pembaruan DNS.
discovered[]

object (DnsRecordSet)

Hanya output. Kumpulan data DNS yang ditemukan App Hosting saat memeriksa domain.
desired[]

object (DnsRecordSet)

Hanya output. Kumpulan data DNS yang diperlukan App Hosting agar dapat menayangkan konten yang aman di domain.
checkTime

string (Timestamp format)

Hanya output. Terakhir kali App Hosting memeriksa data DNS domain kustom Anda.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

DnsRecordSet

Kumpulan data DNS yang relevan dengan penyiapan dan pemeliharaan domain kustom di App Hosting.

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

string

Hanya output. Nama domain yang terkait dengan kumpulan data.
checkError

object (Status)

Hanya output. Terjadi error pada layanan Hosting Aplikasi saat membuat kueri data DNS domain Anda. Catatan: App Hosting mengabaikan error NXDOMAIN, karena error tersebut umumnya hanya berarti bahwa nama domain belum disiapkan.
records[]

object (DnsRecord)

Hanya output. Kumpulan data di domain.

{i>DnsRecord<i}

Representasi data DNS untuk domain.

Data DNS adalah data resource yang menentukan perilaku sistem dan layanan saat menangani permintaan untuk domain. Misalnya, saat menambahkan data A ke data DNS domain, Anda memberi tahu sistem lain (seperti browser web pengguna) untuk menghubungi alamat IPv4 tersebut guna mengambil resource yang relevan dengan domain Anda (seperti file App Hosting).

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

string

Hanya output. Domain yang terkait dengan data, mis. foo.bar.com..
type

enum (Type)

Hanya output. Jenis kumpulan data, yang menentukan data apa saja yang terdapat dalam kumpulan data.
rdata

string

Hanya output. Data kumpulan data. Arti nilai bergantung pada jenis data: - A dan AAAA: Alamat IP untuk domain tersebut. - CNAME: Domain lain untuk memeriksa data. - TXT: String teks arbitrer yang terkait dengan domain. App Hosting menggunakan data TXT untuk menentukan project Firebase yang memiliki izin untuk bertindak atas nama domain. - CAA: Flag, tag, dan nilai data, mis. 0 issue "pki.goog".
requiredAction

enum (Action)

Hanya output. Enum yang menunjukkan tindakan yang diperlukan untuk kumpulan data ini. Diisi saat data adalah bagian dari perubahan yang diperlukan dalam kumpulan data DnsUpdates discovered atau desired.
relevantState[]

enum (CustomDomainState)

Hanya output. Enum yang menunjukkan pada negara bagian mana data DNS ini diterapkan. Diisi untuk semua data dengan tindakan yang diperlukan ADD atau REMOVE.

Jenis

Jenis data DNS, termasuk A, TXT, AAAA, dan CAA.

Enum
TYPE_UNSPECIFIED Jenis kumpulan data tidak ditentukan. Pesan tidak valid jika tidak ditentukan.
A Data A, seperti yang ditentukan dalam RFC 1035. {i>Record<i} A menentukan ke alamat IPv4 mana domain mengarahkan lalu lintas data.
CNAME Data CNAME, seperti yang ditentukan dalam RFC 1035. Data CNAME atau Nama Kanonis memetakan domain ke domain kanonis yang berbeda. Jika ada data CNAME, data tersebut harus menjadi satu-satunya data di domain.
TXT Data TXT, seperti yang ditentukan dalam RFC 1035. Kumpulan data TXT menyimpan data teks arbitrer pada domain. Hosting menggunakan data TXT untuk menetapkan Project Firebase yang memiliki izin untuk bertindak di domain.
AAAA Data AAAA, seperti yang ditentukan dalam data AAAA RFC 3596 menentukan alamat IPv6 mana yang menjadi tujuan traffic dari domain.
CAA

Data CAA, seperti yang didefinisikan dalam RFC 6844. CAA, atau Certificate Authority Authorization, catatan menentukan Certificate Authority (organisasi pembuatan sertifikat SSL) mana yang diotorisasi untuk membuat sertifikat bagi domain. App Hosting menggunakan pki.goog sebagai CA utamanya.

Data CAA bersifat menurun. Data CAA di foo.com juga berlaku untuk bar.foo.com kecuali jika bar.foo.com memiliki kumpulan data CAA sendiri.

Data CAA bersifat opsional. Jika domain dan induknya tidak memiliki data CAA, semua CA diberi otorisasi untuk membuat sertifikat atas namanya. Secara umum, App Hosting hanya meminta Anda untuk mengubah data CAA jika permintaan tersebut diperlukan untuk membuka pemblokiran pembuatan sertifikat SSL.

Tindakan

Jenis tindakan yang harus Anda lakukan pada data DNS ini untuk mengonfigurasi domain agar dapat digunakan dengan App Hosting.

Enum
NONE Anda tidak perlu melakukan tindakan apa pun.
ADD Tambahkan data ini ke data DNS Anda.
REMOVE Hapus data ini dari data DNS Anda.

DomainState Khusus

Kumpulan status yang relevan dengan fungsi domain kustom yang sehat.

Enum
CUSTOM_DOMAIN_STATE_UNSPECIFIED Pesan ini tidak valid jika tidak ditentukan.
HOST_STATE Status host domain kustom.
OWNERSHIP_STATE Status kepemilikan domain kustom.
CERT_STATE Status sertifikat domain kustom.

Metode

create

 Menautkan domain baru ke backend.

delete

 Menghapus satu domain.

get

 Mendapatkan informasi tentang domain.

list

 Mencantumkan domain backend.

patch

 Memperbarui informasi untuk satu domain.