操作场景
开放API前,您需要为API分组绑定一个或多个独立域名,API网关通过独立域名定位到此分组。如果您未绑定独立域名,那么调用API时默认使用子域名,API网关对子域名的访问次数做了限制,每天最多可以访问1000次。
每个分组最多可以绑定5个独立域名。
在绑定域名前,您需要理解以下2个概念:
子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。
独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。
前提条件
1.已有独立域名。
2.已将独立域名CNAME解析到分组的子域名上,具体方法请参见《云解析服务用户指南》的“管理记录集”章节。
3.如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前准备SSL证书。此证书不支持导入,您需要填写证书的名称、内容和密钥。
操作步骤
步骤 1登录管理控制台。
步骤 2单击管理控制台左上角,然后单击“API网关 APIG”。
步骤 3在左侧导航单击“专享版”,进入专享版实例列表页,单击“查看控制台”,进入API开发与调用管理页面。
步骤 4单击“开放API > API分组”,进入到API分组信息页面。
步骤 5通过以下任意一种方式,进入“域名管理”页签。
单击分组名称,进入分组详细信息页面。单击“域名管理”。
在待绑定域名的分组所在行,单击“更多 > 域名管理”。
步骤 6单击“绑定独立域名”,设置域名信息。
专享版实例可设置域名支持的最小TLS版本:TLS1.1或TLS1.2。推荐使用TLS1.2。
步骤 7单击“确定”,将独立域名与API分组绑定。
如果不再需要此域名时,在域名所在行,单击“解除绑定”。
步骤 8(可选)绑定SSL证书。API分组中的API支持HTTPS请求协议时,需要添加SSL证书。
1.单击“添加SSL证书”,弹出“添加SSL证书”对话框。
2.根据已获取SSL证书,输入证书名称、证书内容和密钥,单击“确定”,完成SSL证书的添加。
SSL证书目前仅支持pem类型,如需添加其它证书类型,可转换成pem类型后添加。
如果需要编辑此SSL证书,单击证书名称后的,修改证书名称。由于证书内容和密钥已经加密,不支持再次查看,如果需要修改,请重新输入新的证书内容或者密钥。
如果不再需要此SSL证书,在域名所在行,单击“删除SSL证书”。
常见问题
绑定域名失败常见原因:未将独立域名CNAME解析到分组的子域名上或域名重复。
添加SSL证书失败常见原因:生成证书的域名和实际添加证书所用的域名不一致。
后续操作
绑定独立域名后,您可以开始创建API,将API接口配置在API网关中,开放后端能力。