Data Service 中的自定义域名

TiDB Cloud Data Service 提供默认域名 <region>.data.tidbcloud.com 来访问每个 Data App 的端点。为了增强个性化和灵活性，你可以为你的 Data App 配置自定义域名，而不是使用默认域名。

本文档描述如何在你的 Data App 中管理自定义域名。

开始之前

在为你的 Data App 配置自定义域名之前，请注意以下事项：

• 自定义域名请求出于安全考虑仅支持 HTTPS。一旦你成功配置自定义域名，系统会自动应用 "Let's Encrypt" 证书。
• 你的自定义域名在 TiDB Cloud Data Service 中必须是唯一的。
• 每个默认域名（由集群所在区域决定）只能配置一个自定义域名。

管理自定义域名

以下部分描述如何为 Data App 创建、编辑和删除自定义域名。

创建自定义域名

要为 Data App 创建自定义域名，请执行以下步骤：

1. 导航到项目的 Data Service 页面。
2. 在左侧窗格中，点击目标 Data App 的名称以查看其详细信息。
3. 在管理自定义域名区域，点击添加自定义域名。
4. 在添加自定义域名对话框中，执行以下操作：
   1. 选择要替换的默认域名。
   2. 输入你想要的自定义域名。
   3. 可选：配置自定义路径作为端点的前缀。如果自定义路径留空，则使用默认路径。
5. 预览你的基础 URL 以确保它符合你的预期。如果看起来正确，点击保存。
6. 按照 DNS 设置对话框中的说明，在你的 DNS 提供商中为默认域名添加 CNAME 记录。

自定义域名最初处于待验证状态，系统会验证你的 DNS 设置。一旦 DNS 验证成功，你的自定义域名状态将更新为成功。

在你的自定义域名状态设置为成功后，你就可以使用它来访问你的端点。TiDB Cloud Data Service 提供的代码示例会自动更新为你的自定义域名和路径。更多信息，请参见调用端点。

编辑自定义域名

要编辑 Data App 的自定义域名，请执行以下步骤：

1. 导航到项目的 Data Service 页面。
2. 在左侧窗格中，点击目标 Data App 的名称以查看其详细信息。
3. 在管理自定义域名区域，找到操作列，然后在要编辑的自定义域名行中点击 编辑。
4. 在显示的对话框中，更新自定义域名或自定义路径。
5. 预览你的基础 URL 以确保它符合你的预期。如果看起来正确，点击保存。
6. 如果你更改了自定义域名，请按照 DNS 设置对话框中的说明，在你的 DNS 提供商中为默认域名添加 CNAME 记录。

删除自定义域名

要删除 Data App 的自定义域名，请执行以下步骤：

1. 导航到项目的 Data Service 页面。
2. 在左侧窗格中，点击目标 Data App 的名称以查看其详细信息。
3. 在管理自定义域名区域，找到操作列，然后在要删除的自定义域名行中点击 删除。
4. 在显示的对话框中，确认删除。