REST Resource: projects.locations.backends.domains

資源：Domain

與後端相關聯的網域名稱。

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
}
欄位
name

string

ID。網域的資源名稱，例如/projects/p/locations/l/backends/b/domains/foo.com
displayName

string

選用設定。使用者可理解的網域名稱。長度上限為 63 個半形字元。例如：prod domain。
createTime

string (Timestamp format)

僅供輸出。網域建立時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。網域上次更新時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
type

enum (Type)

僅供輸出。網域類型。
disabled

boolean

選用設定。網域是否已停用。預設值為 false。
serve

object (ServingBehavior)

選用設定。網域的提供行為。如有指定，網域將提供並非後端線上內容的內容。
customDomainStatus

object (CustomDomainStatus)

僅供輸出。代表 CUSTOM 類型網域的狀態和設定。且只會出現在該類型的網域上。
reconciling

boolean

僅供輸出。如果欄位為 true，表示建構作業有進行中的 LRO。
deleteTime

string (Timestamp format)

僅供輸出。網域刪除時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
purgeTime

string (Timestamp format)

僅供輸出。虛刪除網域應遭到清除的時間，算繪後將永久刪除。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
labels

map (key: string, value: string)

選用設定。以鍵/值組合形式加上標籤

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
annotations

map (key: string, value: string)

選用設定。以鍵/值組合的形式呈現註解。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
uid

string

僅供輸出。系統指派的專屬 ID。
etag

string

僅供輸出。以其他值為基礎的伺服器運算總和檢查碼；更新或刪除時可能傳送，以確保作業會在預期的資源上完成。

類型

網域類型。

列舉
TYPE_UNSPECIFIED 未指定類型 (這種情況不應該發生)。
DEFAULT 預設、App Hosting 提供及管理的網域。這些網域是透過父項後端自動建立，無法刪除 (刪除父項資源除外)，且無法移至其他後端。您可以透過 disabled 欄位停用預設網域。
CUSTOM 開發人員擁有的自訂網域。自訂網域可讓你將自有網域連結至 App Hosting 後端，並設定該網域來提供後端內容。

放送行為

指出 App Hosting 是否會在網域提供內容。

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.
}
欄位
聯集欄位 serving_behavior。如有指定，系統會自訂網域的提供行為。serving_behavior 只能採用下列其中一種設定：
redirect

object (Redirect)

選用設定。網域的重新導向行為 (如有提供)。

重新導向

指定網域的重新導向行為。

JSON 表示法 
{
  "uri": string,
  "status": string
}
欄位
uri

string

執行個體類型，重新導向的預定目的地 URI。這個 URI 會加到原始要求路徑的前方。系統會將無配置的 URI 假設為 HTTPS。
status

string (int64 format)

選用設定。在重新導向回應中使用的狀態碼。必須是有效的 HTTP 3XX 狀態碼。如果沒有提供，則預設值為 302。

自訂網域狀態

自訂網域與後端的連結狀態。

JSON 表示法 
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
欄位
hostState

enum (HostState)

僅供輸出。追蹤是否偵測到自訂網域適當地將流量導向 App Hosting。
ownershipState

enum (OwnershipState)

僅供輸出。根據網域的 DNS 記錄，追蹤後端是否獲准在網域提供內容。
certState

enum (CertState)

僅供輸出。追蹤網域的 SSL 憑證狀態。
requiredDnsUpdates[]

object (DnsUpdates)

僅供輸出。列出必須在自訂網域 DNS 中新增或移除的記錄，才能完成設定並開始提供內容。參與階段會提供這個欄位。如果上述一或多個狀態不是 *_ACTIVE，系統會在加入程序完成後顯示這個程式碼，表示網域的 DNS 記錄狀態不佳。
issues[]

object (Status)

僅供輸出。網域設定問題清單。允許使用者自行修正 DNS 記錄問題。

主機狀態

網域的主機狀態。主機狀態取決於每個與您網域相關的 IP 位址，確認網域是否透過 App Hosting 來源的適當資料分割提供。

列舉
HOST_STATE_UNSPECIFIED 您未指定自訂網域的主機狀態。如未指定，則訊息無效。
HOST_UNHOSTED 您的自訂網域未與任何 IP 位址建立關聯。
HOST_UNREACHABLE 系統無法連線至你的自訂網域。App Hosting 服務透過 DNS 查詢找出您網域的 IP 位址，但發生錯誤。詳情請參閱 CustomDomainStatus 的「issues」欄位。
HOST_NON_FAH 您的網域只有不會解析至 App Hosting 的 IP 位址。
HOST_CONFLICT 您網域的 IP 位址會解析為 App Hosting 和其他服務。為確保結果一致，請移除與非應用程式代管服務相關的 A 和 AAAA 記錄。
HOST_WRONG_SHARD 網域的 IP 位址解析為不正確的區域和/或 App Hosting 複製資料分割。
HOST_ACTIVE 所有對您網域提出的要求都是由 App Hosting 透過網域獲派的資料分割處理。如果自訂網域的 OwnershipState 也是 OWNERSHIP_ACTIVE，App Hosting 會針對網域的要求提供後端內容。

擁有權狀態

自訂網域的擁有權狀態。

列舉
OWNERSHIP_STATE_UNSPECIFIED 您未指定自訂網域的擁有權狀態。這種情況絕不應該發生。
OWNERSHIP_MISSING 自訂網域網域沒有「應用程式代管」相關擁有權記錄。沒有任何後端有權在這個來源資料分割的網域提供服務。
OWNERSHIP_UNREACHABLE 系統無法連線至你的自訂網域。App Hosting 服務透過 DNS 查詢找出網域擁有權記錄，但發生錯誤。詳情請參閱 CustomDomainStatus 的「issues」欄位。
OWNERSHIP_MISMATCH 你的自訂網域已由其他 App Hosting 自訂網域擁有。移除衝突的記錄，並替換為目前自訂網域的記錄。
OWNERSHIP_CONFLICT 你的自訂網域有衝突的 TXT 記錄，指出目前自訂網域有一或多位使用者的擁有權。移除多餘的擁有權記錄，授予目前的自訂網域擁有權。
OWNERSHIP_PENDING 自訂網域的 DNS 記錄設定正確無誤。App Hosting 會在 24 小時內將您的網域擁有權轉移至這個自訂網域。
OWNERSHIP_ACTIVE 您的自訂網域擁有自己的網域。

憑證

App Hosting 為你網域名稱目前的 SSL 憑證狀態。這可以表示實際憑證的狀態，如果是新的自訂網域，App Hosting 正在嘗試建立憑證。

列舉
CERT_STATE_UNSPECIFIED 未指定憑證的狀態。如未指定，則訊息無效。
CERT_PREPARING 每個憑證的初始狀態，代表 App Hosting 有意在向憑證授權單位提出要求前建立憑證。
CERT_VALIDATING App Hosting 會驗證網域名稱的 DNS 記錄是否處於允許代表該名稱建立憑證的狀態。
CERT_PROPAGATING 憑證最近才建立，需要一段時間才能在 App Hosting 負載平衡器中全面生效。
CERT_ACTIVE 憑證處於有效狀態，能為其代表的網域名稱提供安全連線。
CERT_EXPIRING_SOON 憑證即將到期，上面的所有網域名稱都會獲得新憑證。
CERT_EXPIRED 憑證已到期。App Hosting 無法再透過你的網域名稱提供安全內容。

DNS 更新

您應更新一組 DNS 記錄更新，允許 App Hosting 回應網域發出的要求，提供安全內容。這些更新會顯示網域和相關子網域的目前狀態App Hosting 上次查詢 DNS 記錄的時間，以及您希望自訂網域全面啟用前，App Hosting 必須查看的一組記錄。

JSON 表示法 
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
欄位
domainName

string

僅供輸出。與 DNS 更新相關聯的網域名稱。
discovered[]

object (DnsRecordSet)

僅供輸出。檢查網域時發現的 DNS 記錄集。
desired[]

object (DnsRecordSet)

僅供輸出。App Hosting 需要一組 DNS 記錄，才能在網域中提供安全內容。
checkTime

string (Timestamp format)

僅供輸出。App Hosting 上次檢查自訂網域的 DNS 記錄時。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

DnsRecordSet

與 App Hosting 自訂網域的設定和維護相關的一組 DNS 記錄。

JSON 表示法 
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
欄位
domainName

string

僅供輸出。屬於記錄集的網域名稱。
checkError

object (Status)

僅供輸出。查詢網域的 DNS 記錄時，App Hosting 服務發生錯誤，注意：App Hosting 會忽略 NXDOMAIN 錯誤，這通常只是表示尚未設定網域名稱。
records[]

object (DnsRecord)

僅供輸出。網域中的記錄。

DNS 記錄

網域的 DNS 記錄表示法。

DNS 記錄是一種資源記錄，可定義系統和服務在處理網域要求時應採取的行為。舉例來說，如果您在網域的 DNS 記錄中加入 A 記錄，系統就會通知其他系統 (例如使用者的網路瀏覽器) 與這些 IPv4 位址聯絡，以便擷取與您網域相關的資源 (例如 App Hosting 檔案)。

JSON 表示法 
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
欄位
domainName

string

僅供輸出。記錄所含的網域，例如：foo.bar.com.。
type

enum (Type)

僅供輸出。記錄的類型，會決定記錄中包含的資料類型。
rdata

string

僅供輸出。記錄的資料。這個值的意義取決於記錄類型：- A 和 AAAA：網域的 IP 位址。- CNAME：另一個要檢查記錄的網域。- TXT：與網域相關聯的任意文字字串。App Hosting 會根據 TXT 記錄來判定哪些 Firebase 專案有權代表網域執行動作。- CAA：記錄的旗標、標記和值，例如0 issue "pki.goog"。
requiredAction

enum (Action)

僅供輸出。列舉，表示這項記錄的必要動作。當 DnsUpdates discovered 或 desired 記錄集的必要變更記錄包含此項目時，系統就會填入資料。
relevantState[]

enum (CustomDomainState)

僅供輸出。列舉，指出這個 DNS 記錄適用的狀態。已填入 ADD 或 REMOVE 必要動作的所有記錄。

類型

DNS 記錄的類型，包括 A、TXT、AAAA 和 CAA。

列舉
TYPE_UNSPECIFIED 未指定記錄的類型。如未指定，則訊息無效。
A RFC 1035 中定義的 A 記錄。A 記錄會決定網域將流量導向哪些 IPv4 位址。
CNAME RFC 1035 中定義的 CNAME 記錄。CNAME 或正規名稱記錄會將網域對應至其他的標準網域。如有 CNAME 記錄，這應該是網域上唯一的記錄。
TXT RFC 1035 中定義的 TXT 記錄。TXT 記錄會保留網域中的任意文字資料。「託管」會使用 TXT 記錄，決定哪些 Firebase 專案有權對網域執行動作。
AAAA 根據 RFC 3596 AAAA 記錄中的定義，AAAA 記錄會決定網域將流量導向哪些 IPv6 記錄。
CAA

CAA 記錄，如 RFC 6844 中定義。CAA (簡稱「憑證授權單位授權」) 的記錄會決定哪些憑證授權單位 (SSL 憑證採礦機構) 有權建立網域憑證。App Hosting 使用 pki.goog 做為主要 CA。

CAA 記錄序列。除非 bar.foo.com 擁有自己的一組 CAA 記錄，否則 foo.com 上的 CAA 記錄也會套用至 bar.foo.com。

CAA 記錄為選用項目。如果網域及其父項沒有 CAA 記錄，則所有 CA 均有權代表網域建立憑證。一般來說，App Hosting 只會在需要修改 CAA 記錄時要求您修改 CAA 記錄，才能解除封鎖 SSL 憑證建立作業。

動作

設定這個 DNS 記錄時，您應該採取何種行動，以設定要搭配 App Hosting 使用的網域。

列舉
NONE 不需要採取任何行動。
ADD 將這筆記錄新增至 DNS 記錄。
REMOVE 從 DNS 記錄中移除這筆記錄。

自訂網域狀態

一組與自訂網域健全運作相關的狀態。

列舉
CUSTOM_DOMAIN_STATE_UNSPECIFIED 如未指定，則這則訊息無效。
HOST_STATE 自訂網域的主機狀態。
OWNERSHIP_STATE 自訂網域的擁有權狀態。
CERT_STATE 自訂網域的憑證狀態。

方法

create

 將新網域連結至後端。

delete

 刪除單一網域，

get

 取得網域相關資訊。

list

 列出後端的網域。

patch

 更新單一網域的資訊。