在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。
- 调试域名(子域名):API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。
- 独立域名:您自定义的域名。最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。
说明
同一实例下的不同分组不能绑定相同的独立域名。
调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。
当独立域名为泛域名(例如*.aaa.com)时,用户可以通过泛域名的所有子域名(例如default.aaa.com,1.aaa.com)访问所绑定分组下的所有API。
前提条件
- 已有独立域名。
- 已将独立域名A记录解析到实例的入口地址上。
- 如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前获取SSL证书的内容和密钥,并创建SSL证书。
操作步骤
步骤 1 进入API网关控制台页面。
步骤 2 根据实际业务在左侧导航栏上方选择实例。
步骤 3 在左侧导航栏选择“API管理 > API分组”。
步骤 4 单击 分组名称 。
步骤 5 单击“分组信息”页签。
步骤 6 在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。
表 独立域名配置
信息项 | 描述 |
---|---|
域名 | 填写要绑定的域名。 |
支持最小TLS版本 | 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 |
支持http to https自动重定向 | 支持独立域名开启http to https自动重定向。 |
步骤 7 单击“确定”,将独立域名与API分组绑定。
如果不再需要此域名时,在域名所在行,单击“解绑域名”。
步骤 8 (可选)如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。
常见问题
- 绑定域名失败常见原因:未将独立域名CNAME解析到分组的调试域名上或域名重复。
- 添加SSL证书失败常见原因:生成证书的域名和实际添加证书所用的域名不一致。
支持http to https自动重定向
约束限制
由于浏览器限制,非GET或非HEAD方法的重定向可能导致数据丢失,因此API请求方法限定为GET或HEAD。
开启重定向需满足以下条件:
- 创建API时,前端配置的请求协议选择“HTTPS”或“HTTP&HTTPS”。
- API所属API分组已绑定独立域名和SSL证书。
独立域名绑定完成后,在“支持http to https自动重定向”列开启重定向功能。