--- title: "カスタムホスト名を設定する" slug: "set-up-a-custom-hostname" abstract: "カスタムホスト名の設定方法。" --- # カスタムホスト名を設定する このウォークスルーでは、カスタムホストネームの設定方法を説明します。カスタムホストネームは、組織のドメインのサブドメインを使ってSitecore APIへのアクセスを可能にします。例えば {YOUR\_CUSTOM\_HOSTNAME}.example.com. 自分のドメインを使ってSitecore APIにアクセスするためにカスタムホスト名を追加できます。 カスタムホスト名を設定するには、まずSitecore Cloud Portalから作成するかEdge [Platform Admin REST API](https://api-docs.sitecore.com/portal/edge-platform-admin-rest-api)を使って作成し、ドメインプロバイダーで検証する必要があります。 このウォークスルーでは、以下の方法を説明します: :::攻略 1. [カスタムホスト名を作成する](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/custom-hostnames/set-up-a-custom-hostname.html#create-a-custom-hostname) 2. [ホストネーム所有権の検証](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/custom-hostnames/set-up-a-custom-hostname.html#validate-hostname-ownership) 3. [カスタムホスト名のステータスを確認してください](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/custom-hostnames/set-up-a-custom-hostname.html#check-the-status-of-your-custom-hostname)::: > !注**始める前に** > > - Sitecore Cloud Portal組織の*Organization Admin*または*Organization Owner*でなければなりません。 > > - ドメイン名を持ち、ドメインホストでTXTレコードを作成する能力が必要です。 > ## カスタムホスト名を作成する > !注現在、カスタムホストネームは .example.comのようなサブドメインでなければなりません。ワイルドカードや頂点ドメインはサポートされていません。 Sitecore Cloud PortalまたはEdge Platform APIを使ってカスタムホスト名を作成し、レスポンスの情報を使ってドメインのDNSレコードにレコードを追加します。 作成できるホスト名の最大数は契約によって決まります。この上限を増やすには、Sitecoreの担当者までお問い合わせください。 カスタムホスト名を作成するには: ::::タブ:::tab{title="Browser"} ### Sitecore Cloud Portal 1. [カスタムホスト名ページ](https://portal.sitecorecloud.io/admin/custom-hostnames)を開き、「**カスタムホスト名を作成する」**をクリックしてください。 2. 「 **カスタムホスト名の作成** 」ダイアログの **ホストネー** ム欄で、作成予定のカスタムホスト名を入力します。ワイルドカードや頂点ドメインはサポートされていません。 3. **Default Context ID**フィールドに、カスタムホスト名に関連付けられたデフォルトの[コンテキストID](https://doc.sitecore.com/xmc/en/developers/xm-cloud/en/context-id-environment-variables.html)を入力します。 もし今、デフォルトのコンテキストIDの値を指定していない場合、ホスト名にリクエストするたびにクエリパラメータやヘッダーにコンテキストIDを指定する必要があります。 > !注カスタムホスト名はライブコンテキストIDとExperience Edgeに公開されたメディアアイテムにのみ使用可能です。 4. **Default site ID**欄で、このホスト名に付けたいサイト名を入力してください。サイトIDはDeployアプリの開発者設定タブにあるSITECORE\_SITE\_NAME変数の値です。 今、デフォルトのサイトIDの値を指定していなければ、ホスト名にリクエストするたびにクエリパラメータやボディにサイトIDを指定する必要があります。 5. 「 **作成**」をクリックします。ホスト名が作成され、「 **ホスト名記録** 」ダイアログが表示されます。 ::::::tab{title="Server"} ### エッジプラットフォームAPI 1. [Sitecore Cloud Portal](https://portal.sitecorecloud.io/)組織にログインし、メニューバーの右上隅でプロフィール **![profile.PNG](https://doc.sitecore.com/api/markdown-image/portal/ja/developers/sitecore-cloud-portal/images/profile.PNG) > API**トークンをクリックし、**ベアラートークン**をコピーしてください。 2. [エンドポイントAPIカスタムホスト名を作成する](https://api-docs.sitecore.com/portal/edge-platform-admin-rest-api/organizations/post_em)ためにhttps://edge-platform-admin-api.sitecorecloud.io/api/admin/v1/hostnamesPOSTリクエストを出してください。 名称 概要 例 hostname 作成予定のカスタムホスト名。ワイルドカードやApexドメインはサポートされていません。 example.site.com defaultContextId カスタムホスト名に関連付けられたデフォルトの [コンテキストID](https://doc.sitecore.com/xmc/en/developers/xm-cloud/en/context-id-environment-variables.html) です。 もし今、デフォルトのコンテキストIDの値を指定していない場合、ホスト名にリクエストするたびにクエリパラメータやヘッダーにコンテキストIDを指定する必要があります。 4N1c0nt3xtjDksn997CRp9T defaultSiteId このホスト名に付けたいサイト名です。サイトIDは、[SitecoreAI Deployアプリの開発者設定タブ](https://doc.sitecore.com/xmc/en/developers/xm-cloud/get-the-environment-variables-for-a-site.html)にあるSITECORE\_SITE\_NAME変数の値です。 今、デフォルトのサイトIDの値を指定していなければ、ホスト名にリクエストするたびにクエリパラメータやボディにサイトIDを指定する必要があります。 exampleSitecoreSite サンプルリクエスト: curl --location 'https://edge-platform-admin-api.sitecorecloud.io/api/admin/v1/hostnames' \\ --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer ' \\ --data '{ "hostname": "example.site.com", "defaultSiteId": "exampleSitecoreSite", "defaultContextId": "4N1NYjlsn100VAsCNrRp9T" }' サンプル回答: { "id": "9f848e0f-e12a-4e93-9989-0ff368033bb", "defaultContextId": "4N1NYjlsn100VAsCNrRp9T", "defaultSiteId": "exampleSitecoreSite", "hostname": "example.site.com", "ssl": { "method": "txt", "status": "pending\_validation", "validation\_errors": , "validation\_records": { "txt\_name": "\_acme-challenge.example.site.com", "txt\_value": "2\_hWDRQIToMYxecCennD1WXLdhiou1cHV0meL0jUI" } }, "ownership\_verification": { "name": "\_cf-custom-hostname.example.site.com", "type": "txt", "value": "45550fdb-1123-4b87-9ec8-htr1e2e3a39" }, "created\_at": "2069-09-03T14:\`26:51\`.518323Z", "status": "pending" } 3. レスポンスをコピーして保存してください。ドメインのDNSレコードにCNAMEとTXTレコードを追加するために必要になります。 ::::::: ## ホストネーム所有権の検証 カスタムホスト名を設定するには、**ホストネームレコード** ダイアログ(Sitecore Cloud Portal使用の場合)またはHTTP応答(Edge Platform API使用時)で提供されるDNSレコードを追加します。使用されるホスト名検証方法によって、これらのレコードには以下が含まれます: - ホスト名の所有権や管理管理を検証するための *TXT Hostname Validation* 記録。 - ドメイン制御検証(DCV)用の *TXT SSL Validation* レコードで、SSL証明書の発行と管理を可能にします。 - カスタムホスト名をSitecoreプロキシに関連付けるための *CNAME* レコードです。 カスタムホストネームを設定する際、ホスト名所有権の検証には2つの方法があります: - TXTホスト名検証なしの自動検証 - CNAMEレコードが追加された後、所有権は自動的に検証されます。 - DNS設定はよりシンプルですが、検証完了前にCNAMEを切り替えると、ホスト名がすでにライブトラフィックを処理している場合、一時的なダウンタイムが発生する可能性があります。 - TXTホスト名検証による事前検証 - 所有権は、CNAMEレコードを切り替える前にTXTホストネーム検証レコードを追加することで確認されます。 - 検証や証明書のプロビジョニングはトラフィックルーティング前に完了できるため、既存ホスト名のオンボーディング時のダウンタイムを最小限に抑えたり回避したりできます。ただし、この方法は追加のDNS設定手順が必要で、DNSゾーンにTXTホスト名検証レコードを追加するなどです。 DNSレコードの追加方法はドメインホストによって異なります。 一般的に、DNSレコードを追加するには: ::::タブ:::tab{title="Browser"} ### Sitecore Cloud Portal 1. ドメイン購入時に使ったアカウントでドメインレジストラにサインインしてください。 2. ドメインのTXTとCNAMEレコードを更新できるセクションに行ってください。これは通常、DNS設定、DNS管理、または詳細設定と呼ばれます。 3. 事前検証を使用している場合は、**ホストネームレコード**ダイアログの**TXTホストネーム検証**セクションの情報を使ってTXTレコードを追加してください。ダイアログを閉じた場合は、「**カスタムホストネー**ム」ページで「**レコードを追加**」をクリックしてください。 4. SSL検証のために、 **TXT SSL検証** セクションの情報を使ってTXTレコードを追加してください。 5. **CNAME**セクションの情報を使ってCNAMEレコードを追加します。 いくつかの例については、[多くの人気ドメインレジストラ向けのGoogleのカスタム指示](https://support.google.com/a/topic/1409901)を参照してください。 ::::::tab{title="Server"} ### エッジプラットフォームAPI 1. ドメイン購入時に使ったアカウントでドメインレジストラにサインインしてください。 2. ドメインのTXTとCNAMEレコードを更新できるセクションに行ってください。これは通常、DNS設定、DNS管理、または詳細設定と呼ばれます。 3. 事前検証を使用する場合は、先に作成した回答から以下の情報を含むTXTレコードを追加してください: - 名前 - ownership\_verification.nameの値(頂点領域を除く)。例えば、値が \_acme-challenge.example.site.comの場合、 \_acme-challenge.example を値として使います。 - 価値 - ownership\_verification.valueの価値。 4. DCVの場合は、以下のテキストレコードを追加します: - 名前 - ssl.validation\_records.txt\_nameの値 、頂点ドメインは含まず。 - 価値 - ssl.validation\_records.txt\_valueの価値。 5. 以下のような条件でCNAMEレコードを追加します: - 名前 - hostnameの価値。 - ターゲット - sitecoreproxy.io いくつかの例については、[多くの人気ドメインレジストラ向けのGoogleのカスタム指示](https://support.google.com/a/topic/1409901)を参照してください。 ::::::: ## カスタムホスト名のステータスを確認してください ドメインレジストラに必要なDNSレコードを追加した後、通常はホスト名が10分以内にアクティブになります。 > !注**ホスト名の検証状況とライフサイクル** > > カスタムホスト名を作成し、必要なDNSレコードを追加した後、ホスト名は検証期間に入ります。ホスト名は「検証保留中」から始まります。検証に十分失敗すると、ステータス*Moved*に移行できます。また、DNSレコードが期待されるフォールバック発信元を指ささなくなった場合、ホスト名は*Moved*を入力できます。 > > もし7日以上*Moved*に留まると、自動的に*Deleted*に移行します。 *Deleted* 、ホスト名が非アクティブでクリーンアップの予定が入っていることを意味します。 > > ユーザーはリフレッシュやPATCHリクエストを送信することで検証を再開できます。 カスタムホスト名の状態を確認するには: ::::タブ:::tab{title="Browser"} ### Sitecore Cloud Portal **カスタムホスト名**のページで、カスタムホスト名の**ホスト名ステータス**を確認してください。ステータスが**ACTIVE**であれば、使用準備完了です。 ::::::tab{title="Server"} ### エッジプラットフォームAPI 1. GETの申請をしてください https://edge-platform-admin-api.sitecorecloud.io/api/admin/v1/hostnames/ curl --location 'https://edge-platform-admin-api.sitecorecloud.io/api/admin/v1/hostnames/example.site.com' \\ --header 'Authorization: Bearer ' 2. レスポンスでstatusの値がactiveかどうかを確認してください。これはホスト名が使える状態にあることを意味します。 ::::::: カスタムホスト名を追加した後は、[それを使って特定のSitecoreサービスへのトラフィックをルーティング](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/custom-hostnames/resolving-a-custom-hostname-during-a-request.html "Resolving a custom hostname during a request")できます。