データサービスのカスタムドメイン

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

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

始める前に

データアプリのカスタムドメインを設定する前に、以下の点にご注意ください。

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

カスタムドメインの管理

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

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

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

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

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

注記：

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

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

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

注記：

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

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

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

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

注記：

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

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

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