データサービスにおけるカスタムドメイン

TiDB Cloudデータサービスは、各データアプリのエンドポイントにアクセスするためのデフォルトドメイン<region>.data.tidbcloud.comを提供します。パーソナライズと柔軟性を高めるために、デフォルトドメインの代わりにデータアプリ用のカスタムドメインを設定することもできます。

このドキュメントでは、データアプリでカスタムドメインを管理する方法について説明します。

始める前に

データアプリのカスタムドメインを構成する前に、次の点に注意してください。

カスタムドメインのリクエストは、セキュリティ保護のためHTTPSのみをサポートします。カスタムドメインの設定が完了すると、「Let's Encrypt」証明書が自動的に適用されます。
カスタムドメインは、 TiDB Cloudデータサービス内で一意である必要があります。
クラスターのリージョンによって決まるデフォルトドメインごとに、カスタムドメインを 1 つだけ構成できます。

カスタムドメインを管理する

次のセクションでは、データアプリのカスタムドメインを作成、編集、削除する方法について説明します。

カスタムドメインを作成する

データアプリのカスタムドメインを作成するには、次の手順を実行します。

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリの名前をクリックして詳細を表示します。
[カスタムドメインの管理]領域で、 [カスタムドメインの追加] をクリックします。
[カスタムドメインの追加]ダイアログボックスで、次の操作を行います。
1. 置き換えたいデフォルトのドメインを選択します。
2. 希望するカスタムドメイン名を入力します。
3. オプション：エンドポイントのプレフィックスとしてカスタムパスを設定します。カスタムパスが空の場合、デフォルトのパスが使用されます。
ベースURLをプレビューして、期待どおりであることを確認します。問題がなければ、 「保存」をクリックします。
DNS 設定ダイアログの指示に従って、DNS プロバイダーのデフォルトドメインのCNAMEレコードを追加します。

システムがDNS設定を検証している間、カスタムドメインは最初は「保留中」ステータスになります。DNS検証が成功すると、カスタムドメインのステータスは「成功」に更新されます。

注記：
ご利用のDNSプロバイダーによっては、DNSレコードの検証に最大24時間かかる場合があります。カスタムドメインが24時間以上検証されていない場合、ステータスは「期限切れ」になります。この場合、カスタムドメインを削除して再試行するしかありません。

カスタムドメインのステータスが「成功」になったら、エンドポイントにアクセスできるようになります。TiDB TiDB Cloud Data Service が提供するコード例は、カスタムドメインとパスに自動的に更新されます。詳細については、エンドポイントを呼び出すご覧ください。

カスタムドメインを編集する

注記：
以下の変更を完了すると、以前のカスタムドメインとカスタムパスは直ちに無効になります。カスタムドメインを変更する場合は、新しいDNSレコードが検証されるまでお待ちください。

データアプリのカスタムドメインを編集するには、次の手順を実行します。

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリの名前をクリックして詳細を表示します。
「カスタムドメインの管理」領域で、 「アクション」列を見つけてクリックします。編集するカスタムドメインの行を編集します。
表示されたダイアログボックスで、カスタムドメインまたはカスタムパスを更新します。
ベースURLをプレビューして、期待どおりであることを確認します。問題がなければ、 「保存」をクリックします。
カスタムドメインを変更した場合は、 [DNS 設定]ダイアログの指示に従って、DNS プロバイダーのデフォルトドメインのCNAMEレコードを追加します。

カスタムドメインを削除する

注記：
カスタムドメインを削除する前に、そのカスタムドメインがもう使用されていないことを確認してください。

データアプリのカスタムドメインを削除するには、次の手順を実行します。

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリの名前をクリックして詳細を表示します。
「カスタムドメインの管理」領域で、 「アクション」列を見つけてクリックします。削除するカスタムドメインの行を削除します。
表示されたダイアログボックスで削除を確認します。