リソース: カスタムドメイン
CustomDomain
ドメイン名を Firebase Hosting サイトにリンクするエンティティです。 CustomDomain
サイトに追加すると、ホスティングがドメイン名に対するリクエストに応じてサイトのコンテンツを提供できるようになります。
JSON表現 |
---|
{ "name": string, "annotations": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "expireTime": string, "etag": string, "hostState": enum ( |
田畑 | |
---|---|
name | 出力のみ。 |
annotations | 人間と機械の両方が読み取り可能な |
createTime | 出力のみ。カスタム ドメインの作成時間。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
updateTime | 出力のみ。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
deleteTime | 出力のみ。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
expireTime | 出力のみ。論理的に削除された RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
etag | 出力のみ。 |
hostState | 出力のみ。この |
ownershipState | 出力のみ。この |
requiredDnsUpdates | 出力のみ。ホスティングが代わりに安全なコンテンツを提供できるようにするために、ドメイン名の DNS レコードに行う必要がある一連の更新。 |
issues[] | 出力のみ。ドメイン名に対して安全なコンテンツを提供するホスティングの機能を確立しようとしたときに、ホスティング システムで発生した一連のエラー。これらの問題を解決して、 |
certPreference | ホスティングがドメイン名に対して作成する SSL 証明書の種類を指定するフィールド。 Spark プランのカスタム ドメインは |
cert | 出力のみ。ホスティングがこのカスタム ドメインのドメイン名に対して持つ SSL 証明書。新しいカスタム ドメインの場合、これは多くの場合、実際の証明書ではなく、証明書を作成するというホスティングの意図を表します。詳細については、 |
redirectTarget | この |
reconciling | 出力のみ。 true の場合、ホスティングのシステムがカスタム ドメインの状態を希望の状態に一致させようとしていることを示すフィールド。これは、 |
labels | 追加のメタデータやフィルタリングに使用されるラベル。 |
ホストの状態
ドメイン名のホスト状態。ホストの状態は、ドメイン名に関連付けられた各 IP アドレスをチェックして、ホスティング コンテンツを提供しているかどうかを確認することで判断されます。
列挙型 | |
---|---|
HOST_STATE_UNSPECIFIED | カスタム ドメインのホスト状態は指定されていません。これが指定されていない場合、メッセージは無効です。 |
HOST_UNHOSTED | カスタム ドメインのドメイン名は IP アドレスに関連付けられていません。 |
HOST_UNREACHABLE | カスタム ドメインのドメイン名にアクセスできません。ドメイン名の IP アドレスを見つけるためのホスティング サービスの DNS クエリでエラーが発生しました。詳細については、 CustomDomain オブジェクトのissues フィールドを参照してください。 |
HOST_MISMATCH | カスタム ドメインのドメイン名には、最終的にホスティングに解決されない IP アドレスが含まれています。 |
HOST_CONFLICT | カスタム ドメインのドメイン名には、ホスティングと他のサービスの両方に解決される IP アドレスが含まれています。一貫した結果を確保するには、非ホスティング サービスに関連するA レコードとAAAA レコードを削除します。 |
HOST_ACTIVE | カスタム ドメインのドメイン名に対するすべてのリクエストは、ホスティングによって処理されます。カスタム ドメインのOwnershipState もACTIVE の場合、ホスティングはホスティング サイトのコンテンツをドメイン名で提供します。 |
所有権状態
ドメインの所有権の状態。ドメインは最大 1 つの Firebase ホスティング サイトによって所有できます。所有権は次の 2 つの方法で決定できます。
* 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 日以上OWNERSHIP_ACTIVE
以外のOwnershipState
にあり、少なくとも 30 日間更新されていない場合、ホスティングの所有権システムはCustomDomain
を削除します。削除されたCustomDomain
を復元するには、 customDomains.undelete
リクエストを作成します。
列挙型 | |
---|---|
OWNERSHIP_STATE_UNSPECIFIED | カスタム ドメインの所有権の状態は指定されていません。こんなことは決してあってはならないことです。 |
OWNERSHIP_MISSING | カスタム ドメインのドメイン名には、ホスティング関連の所有権レコードがありません。 Firebase プロジェクトには、ドメイン名に代わって動作する権限がありません。 |
OWNERSHIP_UNREACHABLE | カスタム ドメインのドメイン名にアクセスできません。ドメイン名の所有権レコードを検索するためのホスティング サービスの DNS クエリでエラーが発生しました。詳細については、 CustomDomain オブジェクトのissues フィールドを参照してください。 |
OWNERSHIP_MISMATCH | カスタム ドメインのドメイン名は別の Firebase プロジェクトによって所有されています。競合するTXT レコードを削除し、現在の Firebase プロジェクトのプロジェクト固有のレコードに置き換えます。 |
OWNERSHIP_CONFLICT | カスタム ドメインのドメイン名には、現在の Firebase プロジェクトと別のプロジェクトの両方による所有権を示す競合するTXT レコードがあります。他のプロジェクトの所有権レコードを削除して、現在のプロジェクトの所有権を付与します。 |
OWNERSHIP_PENDING | カスタム ドメインの DNS レコードは正しく構成されています。ホスティングは 24 時間以内にドメインの所有権をこのCustomDomain に移管します。 |
OWNERSHIP_ACTIVE | カスタム ドメインのドメイン名には、そのプロジェクトに代わって動作する権限を付与するTXT レコードがあります。 |
Dnsアップデート
ドメイン名に対するリクエストに応じてホスティングが安全なコンテンツを提供できるようにするために行う必要がある一連の DNS レコード更新。これらの更新では、ホスティングが最後にクエリを行ったときのドメイン名の DNS レコードの現在の状態と、カスタム ドメインが完全にアクティブになる前にホスティングが確認する必要があるレコードのセットが表示されます。
JSON表現 |
---|
{ "discovered": [ { object ( |
田畑 | |
---|---|
discovered[] | ホスティングがドメインを検査するときに検出した DNS レコードのセット。 |
desired[] | ホスティングがドメイン上で安全なコンテンツを提供するために必要な DNS レコードのセット。 |
checkTime | ホスティングがカスタム ドメインの DNS レコードを最後にチェックした時間。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
DnsRecordSet
Firebase Hosting のカスタム ドメインのセットアップとメンテナンスに関連する DNS レコードのセット。
JSON表現 |
---|
{ "domainName": string, "checkError": { object ( |
田畑 | |
---|---|
domainName | 出力のみ。レコード セットが属するドメイン名。 |
checkError | 出力のみ。ドメイン名の DNS レコードをクエリするときに、ホスティング サービスでエラーが発生しました。注: |
records[] | 出力のみ。ドメイン上のレコード。 |
DnsRecord
DNS レコードは、ドメイン名に対するリクエストを処理するときにシステムとサービスがどのように動作するかを定義するリソース レコードです。たとえば、 A
レコードをドメイン名の DNS レコードに追加すると、他のシステム (ユーザーの Web ブラウザなど) に、それらの IPv4 アドレスにアクセスして、ドメイン名に関連するリソース (ホスティング サイト ファイルなど) を取得するように通知することになります。 )。
JSON表現 |
---|
{ "domainName": string, "type": enum ( |
田畑 | |
---|---|
domainName | 出力のみ。レコードが関連するドメイン名 (例: |
type | 出力のみ。レコードのタイプ。レコードに含まれるデータが決まります。 |
rdata | 出力のみ。レコードのデータ。値の意味はレコード タイプによって異なります。 - A および AAAA: ドメイン名の IP アドレス。 - CNAME: レコードをチェックする別のドメイン。 - TXT: ドメイン名に関連付けられた任意のテキスト文字列。ホスティングは TXT レコードを使用して、どの Firebase プロジェクトがドメイン名に代わって動作する権限を持っているかを判断します。 - CAA: レコードのフラグ、タグ、および値。たとえば |
requiredAction | 出力のみ。このレコードに必要なアクションを示す列挙型。 |
タイプ
DNS レコードのタイプ ( A
、 TXT
、 AAAA
、 CAA
など)。
列挙型 | |
---|---|
TYPE_UNSPECIFIED | レコードのタイプは指定されていません。これが指定されていない場合、メッセージは無効です。 |
A | RFC 1035で定義されているA レコード。レコードは、ドメイン名がトラフィックをどの IPv4 アドレスに向けるかを決定します。 |
CNAME | RFC 1035で定義されているCNAME レコード。 CNAME または正規名レコードは、ドメイン名を別の正規ドメイン名にマップします。 CNAME レコードが存在する場合、それがドメイン名の唯一のレコードである必要があります。 |
TXT | RFC 1035で定義されているTXT レコード。 TXT レコードには、ドメイン名の任意のテキスト データが保持されます。ホスティングはTXT レコードを使用して、どの Firebase プロジェクトにドメイン名を操作する権限があるかを確立します。 |
AAAA | RFC 3596 AAAA レコードで定義されている AAAA レコードは、ドメイン名がトラフィックを送信する IPv6 アドレスを決定します。 |
CAA | RFC 6844で定義されている CAA レコード。 CAA (Certificate Authority Authorization) レコードは、どの認証局 (SSL 証明書作成組織) がドメイン名の証明書の作成を許可されているかを決定します。 Firebase Hosting は、 CAA レコードのカスケード。 CAA レコードはオプションです。ドメイン名とその親に CAA レコードがない場合、すべての CA がそのドメインに代わって証明書を作成する権限を与えられます。一般に、ホスティングは、SSL 証明書の作成のブロックを解除するために CAA レコードの変更が必要な場合にのみ、CAA レコードの変更を要求します。 |
アクション
アクションは、Firebase Hosting で使用できるようにドメインを構成するために、この DNS レコードに対して実行する必要があるアクションのタイプです。
列挙型 | |
---|---|
NONE | アクションは必要ありません。 |
ADD | このレコードを DNS レコードに追加します。 |
REMOVE | このレコードを DNS レコードから削除します。 |
タイプ
証明書のタイプ。ホスティング システムが証明書の作成と維持をどのように処理するかを決定します。
列挙型 | |
---|---|
TYPE_UNSPECIFIED | 証明書の種類は指定されていません。これが指定されていない場合、メッセージは無効です。 |
TEMPORARY | ドメイン名を一時的にカバーする有効期間の短い証明書タイプですが、ホスティングはより永続的な証明書を作成します。 |
GROUPED | Spark プランのカスタム ドメインの標準証明書。 |
PROJECT_GROUPED | ブレイズプランのみ。同じ Firebase プロジェクト上のカスタム ドメインを持つ 1 ~ 100 のドメイン名をカバーする証明書。 |
DEDICATED | ブレイズプランのみ。単一のドメイン名をカバーする証明書。 |
証明書
ドメイン名に対するリクエストにエンドツーエンドの暗号化を提供するために使用される SSL 証明書。 Certificate
、実際の SSL 証明書、または新しく作成されたカスタム ドメインの場合は、ホスティングが作成する意図の SSL 証明書にすることができます。
JSON表現 |
---|
{ "type": enum ( |
田畑 | |
---|---|
type | 出力のみ。証明書のタイプ。 |
state | 出力のみ。証明書の状態。 |
verification | 出力のみ。 DNS レコードまたは既存の非ホスティング ホスティング プロバイダーに追加できる一連の ACME チャレンジ。トラフィックをホスティングに向ける前に、ホスティングがドメイン名の SSL 証明書を作成できるようにします。これらの課題は、古いプロバイダーからホスティングへのダウンタイムゼロの移行の一環として使用できます。 |
issues[] | 出力のみ。ドメイン名の証明書を作成しようとしたときにホスティングで発生した一連のエラー。これらの問題を解決して、ホスティングがサイトの訪問者と安全な通信を提供できるようにします。 |
createTime | 出力のみ。証明書の作成時間。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
expireTime | 出力のみ。証明書の有効期限。この期間を過ぎると、ホスティングとサイト訪問者の間で安全な通信を提供するために証明書を使用できなくなります。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
証明書の状態
ホスティングがドメイン名に対して持つ SSL 証明書の状態。これは、実際の証明書の状態、または新しいカスタム ドメインの場合はホスティングによる証明書の作成の試行のいずれかを表すことができます。
列挙型 | |
---|---|
CERT_STATE_UNSPECIFIED | 証明書の状態は指定されていません。これが指定されていない場合、メッセージは無効です。 |
CERT_PREPARING | すべての証明書の初期状態は、認証局への要求が行われる前に、ホスティングが証明書を作成する意図を表します。 |
CERT_VALIDATING | ホスティングは、ドメイン名の DNS レコードが、ドメイン名の代わりに証明書を作成できる状態にあるかどうかを検証します。 |
CERT_PROPAGATING | 証明書は最近作成されたもので、ホスティングの CDN に伝達されるまでに時間がかかります。 |
CERT_ACTIVE | 証明書はアクティブであり、それが表すドメイン名に安全な接続を提供します。 |
CERT_EXPIRING_SOON | 証明書の有効期限が切れるため、証明書上のすべてのドメイン名に新しい証明書が与えられます。 |
CERT_EXPIRED | 証明書の有効期限が切れています。ホスティングでは、ドメイン名で安全なコンテンツを提供できなくなります。 |
証明書検証
トラフィックをホスティング サーバーに送信する前に、ホスティングがドメイン名の SSL 証明書を作成できるようにするために使用できる一連の ACME チャレンジ。 DNS または HTTP チャレンジのいずれかを使用します。両方を提供する必要はありません。
JSON表現 |
---|
{ "dns": { object ( |
田畑 | |
---|---|
dns | 出力のみ。 DNS レコードに追加する |
http | 出力のみ。既存の非ホスティング ホスティング サービスに追加するファイル。ホスティングにドメイン名の SSL 証明書を作成させる意図を確認します。 |
HTTPアップデート
ホスティングの認証局がドメインの SSL 証明書を作成することを許可する意図を確認する、既存の非ホスティング ホスティング サービスに追加できるファイル。
JSON表現 |
---|
{
"path": string,
"desired": string,
"discovered": string,
"lastCheckTime": string,
"checkError": {
object ( |
田畑 | |
---|---|
path | 出力のみ。ファイルへのパス。 |
desired | 出力のみ。パスで提供されるテキスト文字列。 |
discovered | 出力のみ。ホスティングが最後のチェック中に、指定されたパス上で必要なファイルの内容を見つけることができたかどうか。 |
lastCheckTime | 出力のみ。ホスティング システムがファイルの内容を最後にチェックした時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: |
checkError | 出力のみ。最後の内容チェック中にエラーが発生しました。 null の場合、チェックは正常に完了しました。 |
メソッド | |
---|---|
| CustomDomain を作成します。 |
| 指定されたCustomDomain を削除します。 |
| 指定されたCustomDomain を取得します。 |
| 指定された親ホスティング サイトに関連付けられた各CustomDomain を一覧表示します。 |
| 指定されたCustomDomain を更新します。 |
| 指定されたCustomDomain 論理的に削除されている場合は、削除を取り消します。 |