更新时间:2023-09-12 GMT+08:00
分享

域名管理

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

  • 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。
  • 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。

独立域名不能重复。

前提条件

  1. 已有独立域名。可通过域名注册服务申请新的域名。
  2. 备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。
  3. 已将独立域名CNAME解析到分组的子域名上,具体方法请参见增加CNAME类型记录集
  4. 如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前获取SSL证书的内容和密钥,并创建SSL证书

操作步骤

  1. 进入API中心服务页面
  2. 在左侧导航栏选择API网关代理 > API分组
  3. 单击分组名称。
  4. 单击“分组信息”页签。
  5. 在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。

    表1 独立域名配置

    信息项

    描述

    域名

    填写要绑定的域名。

    支持最小TLS版本

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

    该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。

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

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

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

    1. 在域名所在行单击“添加SSL证书”。
    1. 根据下表参数信息,配置SSL证书。
      • 仅支持添加pem编码格式的SSL证书。
      • 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。RSA为不安全的加密算法,推荐您使用ECDSA和DSA加密算法。
      表2 SSL证书配置

      参数

      配置说明

      证书名称

      填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。

      证书内容

      填写pem编码格式的SSL证书内容。

      以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。

      如果证书为非pem编码格式,可参考转换证书为PEM格式进行证书格式转换。

      密钥

      填写pem编码格式的SSL证书密钥。

      以文本方式打开待上传证书里的KEY格式或PEM格式的私钥文件(后缀名为“.pem”或“.key”),将私钥复制到“密钥”中即可。

常见问题

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

转换证书为PEM格式

格式类型

转换方式(通过OpenSSL工具进行转换)

CER/CRT

将“cert.crt”证书文件直接重命名为“cert.pem”。

PFX

  • 提取私钥命令,以“cert.pfx”转换为“key.pem”为例。

    openssl pkcs12 -in cert.pfx -nocerts -out key.pem

  • 提取证书命令,以“cert.pfx”转换为“cert.pem”为例。

    openssl pkcs12 -in cert.pfx -nokeys -out cert.pem

P7B

  1. 证书转换,以“cert.p7b”转换为“cert.cer”为例。

    openssl pkcs7 -print_certs -in cert.p7b -out cert.cer

  2. 将“cert.cer”证书文件直接重命名为“cert.pem”。

DER

  • 提取私钥命令,以“privatekey.der”转换为“privatekey.pem”为例。

    openssl rsa -inform DER -outform PEM -in privatekey.der -out privatekey.pem

  • 提取证书命令,以“cert.cer”转换为“cert.pem”为例。

    openssl x509 -inform der -in cert.cer -out cert.pem

后续操作

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

相关文档