全部产品

API 分组

API 分组即 API 归属的分组,可以是具体的系统名、模块名或者抽象的标识。目前,移动网关支持创建以下类型的 API 分组:

  • HTTP:符合 RESTful 风格的 HTTP 服务,支持跨 VPC 的服务调用。
  • MPC:mPaaS 独有的 RPC 框架,跨 VPC 的服务调用。

创建分组

登录 mPaaS 控制台后,从左侧导航栏进入移动网关页面。根据业务需要,创建不同类型的 API 分组。

创建 HTTP API 分组

完成以下步骤,创建 HTTP API 分组:

  1. 选择 API 分组 标签,进入 API 分组列表页。
  2. 点击 创建 API 分组 按钮,在弹出的对话框中填写 API 分组信息。
    1
    • 分组类型:选择 HTTP。
    • API 分组:必填,填写服务的业务系统的英文名称。
    • 跨 VPC HTTP:是否允许跨 VPC 服务调用。若打开该开关,则表示允许跨 VPC 服务调用。
      该功能针对 MGS 服务所在的专有网络 VPC 与用户自己的服务所部署的 VPC 非同一网络环境,通过 MGS 调用后端服务时需要跨 VPC 的场景。
      说明:目前仅上海金融区环境提供跨 VPC HTTP 功能。
      启用跨 VPC HTTP 调用功能,还需完成以下配置:
      • 是否支持 HTTPS:MGS 提供通过负载均衡(SLB)HTTPS 监听转发来自 HTTPS 协议的请求的能力,以满足数据加密传输的应用场景。默认支持 HTTPS,如无需使用 HTTPS 域名,选择 即可。
      • HTTPS 域名:仅当选择支持 HTTPS 时需要配置,对应 SLB 上挂载的证书域名。
      • VPC Id:对应服务部署的 ECS 的专有网络或 SLB 实例的所属网络。
      • 实例 IP 或地址:对应服务部署的 ECS 的主私网 IP 信息或 SLB 实例的 IP 地址。
      • 端口号:服务端口号。
        注意
        • 目前 MGS 不支持自签证书,使用跨 VPC HTTPS 时,需要配置 CA 认证证书域名,否则会导致域名解析失败。
        • 单独使用 ECS 配置后端服务时,需要开放 ECS 的安全组端口,避免安全策略拦截。相关端口 IP 信息,请 提交工单 联系技术支持人员获取。
        • 仅支持同地域(Region)的跨 VPC 访问,不支持跨地域的 VPC 访问,例如部署在杭州的服务无法调用上海的服务。同时,地域区分金融区和非金融区,例如杭州金融区和杭州非金融区视作不同地域。
        • 同时使用 SLB 和 ECS 配置后端服务时,需要确保 SLB 和 ECS 在相同的 VPC 内,即服务部署的 ECS 专有网络信息与 SLB 实例的所属网络信息保持一致。
        122
    • 服务地址:业务系统的 HTTP/HTTPS URL。未开启跨 VPC HTTP 功能时需要配置该项。
    • 超时时间:选填,发送请求至业务系统时的超时时间,单位毫秒,默认值:3000 ms。
  3. 完成 API 分组信息配置后,点击 确定 完成分组创建。

创建 MPC API 分组

完成以下步骤,创建 MPC API 分组:

  1. 选择 API 分组 标签,进入 API 分组列表页。
  2. 点击 创建 API 分组 按钮,在弹出的对话框中填写 API 分组信息。
    1
    • 分组类型:选择 MPC。
    • API 分组:必填,填写服务的业务系统的英文名称。
    • 超时时间:选填,发送请求至业务系统时的超时时间,单位毫秒,默认值:3000 ms。
    • Project Name:默认取当前所处环境的 ProjectName。
  3. 完成 API 分组信息配置后,点击 确定 完成分组创建。

配置分组

根据不同的 API 分组类型,完成相应的 API 分组配置。

配置 HTTP API 分组

在分组列表中,找到类型为 HTTP 的分组,在其右侧的 操作 列中点击 详情,进入 HTTP API 分组详情页面。点击右上方的 修改 可配置分组。HTTP 分组的配置项如下:
1

  • 服务地址:HTTP 服务的 URL 地址。
  • 超时时间:单位毫秒,默认 3000 ms。
  • 是否验签:业务系统如需验证调用者的身份,请开启该项。有关如何验证,参见 后端签名校验说明。 开启验签开关后,需完成以下配置:
    • 加签算法:生成签名的算法。移动网关公有云支持 MD5、RSA、SM2 和 SM3 算法。
    • 密钥 Key:后端签名使用的密钥 Key,可以自定义。
    • 密钥内容:后端签名使用的密钥 Value。
      • 当加签算法是 MD5 时,可以自定义。
      • 当加签算法是 RSA 时,为移动网关的公钥。
      • 当加签算法是国密 SM2 或 SM3 时,可以自定义。
        关于如何生成密钥,参见 密钥生成方法

配置 MPC 分组

在分组列表中,找到类型为 MPC 的分组,在其右侧的 操作 列中点击 详情,进入 MPC API 分组详情页面。点击右上方的 修改 可配置分组。MPC 分组的配置项如下:

  • projectName:分组所属租户的 projectName,自动读取,不可修改。
  • 超时时间:单位毫秒,默认 3000 ms。