更新时间:2024-08-07 GMT+08:00

绑定域名

在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。

  • 调试域名(子域名):API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。
  • 独立域名:您自定义的域名。最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。
  • 同一实例下的不同分组不能绑定相同的独立域名。
  • 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。
  • 当独立域名为泛域名(例如*.aaa.com)时,用户可以通过泛域名的所有子域名(例如default.aaa.com,1.aaa.com)访问所绑定分组下的所有API。

前提条件

  1. 已有独立域名。
  2. 已将独立域名A记录解析到实例的入口地址上,具体方法请参见《云解析服务用户指南》的“管理记录集”章节。
  3. 如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前获取SSL证书的内容和密钥,并创建SSL证书

操作步骤

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  3. 在左侧导航栏选择“API管理 > API分组”。
  4. 单击分组名称
  5. 单击“分组信息”页签。
  6. 在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。

    表1 独立域名配置

    参数

    说明

    域名

    填写要绑定的域名。

    支持最小TLS版本

    选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。

    该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。您可以在配置参数页面通过“ssl_ciphers”参数配置HTTPS的加密套件。

    支持http to https自动重定向

    支持独立域名开启http to https自动重定向

  7. 单击“确定”,将独立域名与API分组绑定。

    如果不再需要此域名时,在域名所在行,单击“解绑域名”。

  8. (可选)如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。

    1. 在域名所在行单击“选择SSL证书”。
    1. 在选择SSL证书弹窗中勾选要绑定的SSL证书,然后单击“确定”,完成SSL证书的绑定。
      • 如果选择的SSL证书上传过CA证书,可以勾选“开启客户端认证”即开启HTTPS双向认证。注意,开启/关闭客户端认证会对现有业务有影响,请谨慎操作。
      • 如果证书列表中无可用的SSL证书,可单击“创建SSL证书”,新增SSL证书,具体操作配置请参考创建SSL证书

常见问题

  • 绑定域名失败常见原因:未将独立域名CNAME解析到分组的调试域名上或域名重复。
  • 添加SSL证书失败常见原因:生成证书的域名和实际添加证书所用的域名不一致。

支持http to https自动重定向

约束限制

由于浏览器限制,非GET或非HEAD方法的重定向可能导致数据丢失,因此API请求方法限定为GET或HEAD。

开启重定向需满足以下条件:

  • 创建API时,前端配置的请求协议选择“HTTPS”或“HTTP&HTTPS”。
  • API所属API分组已绑定独立域名和SSL证书,具体操作请参见上文。

独立域名绑定完成后,在“支持http to https自动重定向”列开启重定向功能。

后续操作

绑定独立域名后,您可以开始创建API,将API接口配置在API网关中,开放后端能力。