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 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。ドメインが最後に更新された時刻。

RFC3339 UTC「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 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
purgeTime

string (Timestamp format)

出力専用。削除済み（復元可能）ドメインがパージされ、完全に削除される時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
labels

map (key: string, value: string)

省略可。Key-Value ペアのラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
annotations

map (key: string, value: string)

省略可。Key-Value ペアとしてのアノテーション。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
uid

string

出力専用。システムによって割り当てられた一意の識別子。
etag

string

出力専用。他の値に基づいてサーバーが計算したチェックサム想定されるリソースでオペレーションが実行されるようにするために、更新時または削除時に送信されることがあります。

タイプ

ドメインのタイプ。

列挙型
TYPE_UNSPECIFIED タイプが指定されていません（これは発生しません）。
DEFAULT デフォルトでは、App Hosting が提供するドメインおよびマネージド ドメインが使用されます。これらのドメインは親バックエンドで自動的に作成され、その親を削除する場合を除き、削除することはできません。また、別のバックエンドに移動することもできません。デフォルト ドメインは、disabled フィールドで無効にできます。
CUSTOM デベロッパーが所有するカスタム ドメイン。カスタム ドメインを使用すると、所有するドメインを App Hosting バックエンドに関連付け、バックエンドのコンテンツを提供するようにそのドメインを構成できます。

ServingBehavior

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 です。

CustomDomainStatus

カスタム ドメインのバックエンドへのリンクのステータス。

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 に対して追加または削除する必要があるレコードを一覧表示します。オンボーディング中はフィールドが表示されます。上記の状態の 1 つ以上が *_ACTIVE ではなく、ドメインの DNS レコードが不適切な状態にあることを示すために、オンボーディング後にも表示されます。
issues[]

object (Status)

出力専用。ドメインの設定に関する問題の一覧。DNS レコードに関する問題をユーザーが自分で修正できます。

ホスト状態

ドメインのホストの状態。ホストの状態は、ドメインに関連付けられた各 IP アドレスをチェックし、App Hosting のオリジンの適切なシャードを介して提供されているかどうかを確認することで判断されます。

列挙型
HOST_STATE_UNSPECIFIED カスタム ドメインのホストの状態が指定されていません。指定しない場合、メッセージは無効です。
HOST_UNHOSTED カスタム ドメインは IP アドレスに関連付けられていません。
HOST_UNREACHABLE カスタム ドメインにアクセスできません。App Hosting サービスドメインの IP アドレスを調べる DNS クエリの結果、エラーが発生しました。詳しくは、CustomDomainStatus の issues フィールドをご覧ください。
HOST_NON_FAH ご利用のドメインには、最終的に App Hosting に解決されない IP アドレスしかありません。
HOST_CONFLICT お客様のドメインには、App Hosting と他のサービスの両方に解決される IP アドレスがあります。一貫した結果を得るには、アプリ ホスティング サービス以外のサービスに関連する A レコードと AAAA レコードを削除してください。
HOST_WRONG_SHARD お客様のドメインには、App Hosting の誤ったリージョンまたはレプリケーション シャードに解決される IP アドレスがあります。
HOST_ACTIVE ドメインに対するすべてのリクエストは、ドメインに割り当てられたシャードを介して App Hosting によって処理されます。カスタム ドメインの OwnershipState も OWNERSHIP_ACTIVE の場合、App Hosting はドメインのリクエストでバックエンドのコンテンツを提供します。

所有権の状態

カスタム ドメインの所有権の状態。

列挙型
OWNERSHIP_STATE_UNSPECIFIED カスタム ドメインの所有権の状態が指定されていません。絶対にはなりません。
OWNERSHIP_MISSING カスタム ドメインのドメインに App-Hosting 関連の所有権レコードがありません。このオリジン シャードのドメインでサービスを提供するバックエンドがありません。
OWNERSHIP_UNREACHABLE カスタム ドメインにアクセスできません。App Hosting サービスドメインの所有権レコードを調べる DNS クエリの結果、エラーが発生しました。詳しくは、CustomDomainStatus の issues フィールドをご覧ください。
OWNERSHIP_MISMATCH カスタム ドメインが別の App Hosting カスタム ドメインによって所有されています。競合するレコードを削除し、現在のカスタム ドメインのレコードに置き換えます。
OWNERSHIP_CONFLICT カスタム ドメインに競合する TXT レコードがあります。これらのレコードは、現在のカスタム ドメイン 1 つ以上の他のドメインの所有権を示しています。余分な所有権レコードを削除して、現在のカスタム ドメインの所有権を付与します。
OWNERSHIP_PENDING カスタム ドメインの DNS レコードは正しく構成されています。App Hosting は 24 時間以内にドメインの所有権をこのカスタム ドメインに移行します。
OWNERSHIP_ACTIVE カスタム ドメインはそのドメインを所有しています。

CertState

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 はドメイン名で安全なコンテンツを配信できなくなりました。

DnsUpdates

ドメインに対するリクエストに応じて App Hosting が安全なコンテンツを提供できるようにするために必要な、一連の DNS レコードの更新。これらの更新には、ドメインおよび関連するサブドメインの現在の状態が表示されますApp Hosting が最後にクエリを行った際の DNS レコードと、カスタム ドメインを完全にアクティブにする前に App Hosting が参照する必要がある一連のレコード。

JSON 表現 
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
フィールド
domainName

string

出力専用。DNS の更新に関連するドメイン名。
discovered[]

object (DnsRecordSet)

出力専用。App Hosting がドメインの検査時に検出した DNS レコードのセット。
desired[]

object (DnsRecordSet)

出力専用。App Hosting がドメインで保護されたコンテンツを配信するために必要な DNS レコードのセットです。
checkTime

string (Timestamp format)

出力専用。App Hosting が最後にカスタム ドメインの DNS レコードを確認した時刻。

RFC3339 UTC「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)

出力専用。ドメインのレコード。

DnsRecord

ドメインの DNS レコードを表しています。

DNS レコードは、ドメインに対するリクエストを処理する際にシステムとサービスがどのように動作するかを定義するリソース レコードです。たとえば、A レコードをドメインの DNS レコードに追加すると、他のシステム（ユーザーのウェブブラウザなど）に 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 レコード。レコードは、ドメインがトラフィックを転送する IPv4 アドレスを決定します。
CNAME RFC 1035 で定義されている CNAME レコード。CNAME（正規名）レコードは、ドメインを別の正規ドメインにマッピングします。CNAME レコードが存在する場合、それがドメイン上の唯一のレコードになります。
TXT RFC 1035 で定義されている TXT レコード。TXT レコードは、ドメイン上の任意のテキストデータを保持します。Hosting は TXT レコードを使用して、ドメインで操作する権限を持つ Firebase プロジェクトを決定します。
AAAA RFC 3596 で定義されている AAAA レコードは、ドメインがトラフィックを転送する IPv6 アドレスを決定します。
CAA

RFC 6844 で定義されている CAA レコード。CAA（Certificate Authority Authorization）レコードは、ドメインの証明書を作成する権限を持つ認証局（SSL 証明書作成組織）を決定します。App Hosting は pki.goog をプライマリ CA として使用します。

CAA レコードはカスケードされます。foo.com の CAA レコードは、bar.foo.com に独自の CAA レコードセットがある場合を除き、bar.foo.com にも適用されます。

CAA レコードは省略可能です。ドメインとその親に CAA レコードがない場合、すべての CA が代理で証明書を作成できます。App Hosting は通常、SSL 証明書の作成をブロック解除するために CAA レコードの変更が必要な場合のみ、CAA レコードの変更を求めます。

アクション

App Hosting で使用できるようにドメインを構成するために、この DNS レコードに対して行う必要がある操作の種類。

列挙型
NONE 特別なご対応は不要です。
ADD このレコードを DNS レコードに追加します。
REMOVE このレコードを DNS レコードから削除します。

CustomDomainState

カスタム ドメインの正常な機能に関連する一連の状態。

列挙型
CUSTOM_DOMAIN_STATE_UNSPECIFIED 指定しない場合、このメッセージは無効です。
HOST_STATE カスタム ドメインのホストの状態。
OWNERSHIP_STATE カスタム ドメインの所有権の状態。
CERT_STATE カスタム ドメインの証明書の状態。

メソッド

create

 新しいドメインをバックエンドにリンクします。

delete

 単一のドメインを削除します。

get

 ドメインに関する情報を取得します。

list

 バックエンドのドメインを一覧表示します。

patch

 1 つのドメインの情報を更新します。