配置自定义域名

最近更新时间:2023-11-24 16:31:21

我的收藏

操作场景

用户可通过域名绑定功能,将用户所拥有的独立域名绑定到服务,使得服务能以用户自身独立域名的方式提供。
注意:
服务在创建后由 API 网关为用户提供了默认子域名,用户可用于测试调试,具体子域名规则可见 发布后访问
在面向公网提供服务时,强烈建议您绑定您自己的域名,通过自有域名进行访问服务。

前提条件

确保需绑定的域名已经完成解析配置。
确保您的域名已按照要求完成 ICP 备案
注意
腾讯云 API 网关仅要求域名进行 ICP 备案,在其他域名注册商进行过 ICP 备案的域名也能正常接入。

操作步骤

关联自定义域名

1. 登录 API 网关控制台,在左侧导航栏单击服务
2. 在服务列表页,单击服务 ID,进入服务详情页。
3. 在服务详情页,选择自定义域名,单击页面左上角的新建,可看到对话框可以填写配置信息。但此时先不要填写提交。
4. 在DNS解析中配置 CNAME 记录。如果您使用的是腾讯云云解析 DNS,可参考添加 CNAME 记录
说明
请确保先配置 CNAME 解析,再绑定自定义域名。
由于修改 CNAME 后过一段时间才能生效,请确保生效后再进行绑定操作,否则会配置失败。
关于过一段时间才能生效的原因可参考云解析 DNS 生效时间相关
5. 在新增自定义域名的对话框中,填写配置,单击提交。
说明
如果需要支持独立域名的 HTTPS 协议,需要提交域名的 SSL 证书。证书可以通过文件上传的方式或通过填写证书名称、内容和私钥的方式提交,具体可查看 域名型(DV)免费 SSL 证书
独立域名选择 HTTPS 协议时,也默认支持 WSS 协议。
6. 若需要解绑,需先删除服务内绑定的独立域名,再删除独立域名的 CNAME 记录。

配置强制 HTTPS

在自定义域名配置页面,当协议为 HTTP&HTTPS、HTTPS 时,支持开启强制 HTTPS 功能。开启后,API 网关会将使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议。



配置域名路径映射

1. 在自定义域名列表页,单击操作列的编辑



2. 选择路径映射类型:
默认路径映射:路径的 URL 为自定义域名/环境名,例如www.XXXXX.com/release指向本服务中的发布环境,www.XXXXX.com/prepub指向本服务中的预发布环境,www.XXXXX.com/test指向本服务中的测试环境。



自定义路径映射:路径时的 URL 为自定义域名/自定义路径,这个 URL 则指向您所映射的环境。例如配置路径为/mypath,环境为发布环境,则发布环境的 URL 为www.XXXXX.com/mypath。当您想使用根路径时,可直接配置路径为/



注意
使用自定义路径映射时,原本默认路径映射不生效,即自定义域名/环境名均不生效。配置后自定义路径映射与默认路径映射还可以进行编辑。
3. 单击提交,完成配置。

发布后访问

在绑定自定义域名之后,可按照下面方式访问:
在服务发布后访问 操作指引中详细示例,如下:
您的用户 ID 为123456789,在广州区(gz)创建了名为 register 的服务,其服务 ID 为 service-n904iiau ,并在其中添加了路径为 /user 的 API,现在发布了 register 服务在3套环境
在您联调测试过程中
需要访问 /user 的 API,正确的访问路径为:
发布环境:http://service-n904iiau-123456789.gz.tencentapigw.com/release/user
预发布环境:http://service-n904iiau-123456789.gz.tencentapigw.com/prepub/user
测试环境:http://service-n904iiau-123456789.gz.tencentapigw.com/test/user
在您正式生产访问中
继续基于该示例,假设绑定的自定义域名是 a1b1c1.com ,基于自定义域名的访问方式是:
发布环境:http://a1b1c1.com/release/user
预发布环境:http://a1b1c1.com/prepub/user
测试环境:http://a1b1c1.com/test/user