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

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 時間以上検証されない場合、期限切れステータスになります。この場合、カスタムドメインを削除して再試行するしかありません。

カスタムドメインのステータスがSuccessに設定されると、それを使用してエンドポイントにアクセスできます。TiDB TiDB Cloud Data Service によって提供されるコード例は、カスタムドメインとパスに自動的に更新されます。詳細については、エンドポイントを呼び出す参照してください。

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

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

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

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

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

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

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

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