API 网关为每个服务提供默认的访问域名。如果您希望为服务配置自定义域名,通过自定义域名对外提供能力,可以通过绑定域名功能,将您的自定义域名绑定至服务。本文为您介绍如何绑定自定义域名。
前提条件
- 已在域名注册商处获取待绑定的域名。
- 公网域名需要在工信部完成 ICP 备案或接入备案。火山引擎也提供了备案能力,具体操作可参见 备案流程。
- 如果您的域名使用 HTTPS 协议,需准备证书 。API 网关已对接火山引擎的 证书中心,您可以在火山引擎证书中心购买证书,也可以将您的证书上传至火山引擎证书中心。支持上传单/多/泛域名证书,具体操作可参见 证书管理。
- 已创建服务,具体操作可参见 创建服务。
使用限制
- 一个域名仅能唯一绑定一个服务,域名冲突无法配置成功。
- 绑定自定义域名过程中,无法对当前服务下的所有自定义域名和路由进行增/删/改操作。
- 每个服务可关联的自定义域名数量存在限制,详情可参见 使用限制。
操作步骤
登录 API 网关控制台。
在顶部导航栏,选择目标地域。
在左侧导航栏选择 路由管理 > 服务列表。
在服务列表页面,单击目标服务名称,进入当前服务概览页面。
单击 域名管理,切换至域名管理页签。
在自定义域名区域,单击 绑定域名。
在绑定域名页面,按要求配置信息。
配置项 | 说明 |
---|
服务名 | 显示当前服务的名称。 |
网络类型 | 选择待绑定域名的网络类型,当前仅支持公网类型。 |
绑定域名 | 请输入待绑定的域名。 注意 - 公网域名必须在工信部完成 ICP 备案或接入备案,否则无法配置成功。
- 一个域名仅能唯一绑定一个服务,域名冲突无法配置成功。
|
协议类型 | 选择自定义域名支持的通信协议类型。 - HTTP:仅支持 HTTP 协议的请求。
- HTTPS:仅支持 HTTPS 协议的请求。
- HTTP & HTTPS:同时支持 HTTP 和 HTTPS 协议的请求。
|
证书选择 | 协议类型包含 HTTPS 协议时,需选择前提条件中准备好的 HTTPS 证书。 注意 - 证书中的域名需要与待绑定的域名相匹配。
- 泛域名证书仅支持同级匹配。例如:
*.example.com 能够匹配 a.example.com ,无法匹配 a.b.example.com 。 - 当您需要重复使用同一个多/泛域名证书时,请确保同一网关下选择的证书 ID 一致(在证书中心重复上传内容相同的证书,会得到不同的证书 ID)。否则,在同一浏览器下访问这些域名时,会存在访问失败的情况。
|
单击 确定,完成域名绑定。
后续操作
配置完成后,您需要前往 DNS 服务商处 添加 CNAME 记录,将您的自定义域名指向 API 网关当前服务的默认域名。如果不添加 CNAME 记录,通过自定义域名发送的客户端请求,将无法正确解析至 API 网关。