更新时间:2023-04-26 GMT+08:00

修改API配置

概述

API的环境类信息、控制策略信息、密钥类信息、API授权的黑白名单以及未发布到RELEASE环境的API,为非资产数据,在导入集成资产后需要重新配置。

  • 环境类信息包括独立域名、环境变量、负载通道的云服务器信息、非默认的环境。
  • 控制策略信息包括流量控制策略、访问控制策略、客户端访问控制策略和客户端配额策略。
  • 密钥类信息包括客户端的AppCode、自定义后端的密码和证书类型配置值。

前提条件

已完成集成资产的导入

配置环境类信息

  1. 绑定独立域名。
    1. 在实例控制台的“服务集成 APIC > API分组”页面,单击API分组的名称进入API运行页面。
    2. 在页面左上角选择“分组信息”页签,在“域名管理”下单击“绑定独立域名”,为API分组绑定独立域名。

      具体配置参数说明请参见绑定域名

    3. 完成后单击“确定”。
  2. 新建发布环境。
    1. 在实例控制台的“服务集成 APIC > API策略”页面,选择“环境管理”页签。
    2. 单击“创建环境”,新建API的发布环境。
    3. 完成后单击“确定”。
  3. 添加环境变量。
    1. 在实例控制台的“服务集成 APIC > API分组”页面,单击API分组的名称进入API运行页面。
    2. 在页面左上角选择“分组信息”页签,在“环境变量”下的“环境”参数中选择要添加变量的环境,然后单击“添加环境变量”。

      具体配置参数说明请参见创建环境变量

    3. 完成后单击“确定”。
  4. 修改负载通道的服务器信息。
    1. 在实例控制台的“服务集成 APIC > API策略”页面,选择“负载通道”页签。
    2. 单击负载通道右侧的“编辑”。
    3. 在编辑负载通道页面,修改通道内服务器配置。
      • 对于“服务器添加方式”为“选择云服务器”的负载通道,单击“添加云服务器”,添加负载通道内的服务器。
      • 对于“服务器添加方式”为“指定服务器地址”的负载通道,根据实际使用的后端服务器,修改后端服务地址。

      具体配置参数说明请参见创建负载通道(可选)

    4. 完成后单击“完成”。

配置控制策略信息

  1. 配置流量控制策略。
    1. 在实例控制台的“服务集成 APIC > API策略”页面,选择“策略管理”页签。
    2. 单击“创建策略”,在选择策略类型弹窗中选择“传统策略 > 流量控制”。

      具体配置参数说明请参见创建流量控制策略

    3. 完成后单击“确定”。
    4. 参考配置API的流量控制为API、应用或租户绑定流量控制策略。
  2. 配置访问控制策略。
    1. 在实例控制台的“服务集成 APIC > API策略”页面,选择“策略管理”页签。
    2. 单击“创建策略”,在选择策略类型弹窗中选择“传统策略 > 访问控制”。

      具体配置参数说明请参见创建访问控制策略

    3. 完成后单击“确定”。
    4. 参考配置API的访问控制为API绑定访问控制策略。
  3. 配置凭据访问控制策略。
    1. 在实例控制台的“服务集成 APIC > 凭据管理”页面,选择“凭据管理”页签。
    2. 在凭据右侧单击“设置访问控制”,设置凭据的访问控制策略。

      具体配置参数说明请参见配置API的凭据访问控制

    3. 完成后单击“确定”。
  4. 配置凭据配额策略。
    1. 在实例控制台的“服务集成 APIC > 凭据管理”页面,选择“凭据配额策略”页签。
    2. 单击“创建凭据配额策略”,添加凭据配额策略。

      具体配置参数说明请参见创建凭据配额策略

    3. 完成后单击“确定”。
    4. 参考配置API的凭据配额控制为凭据绑定配额策略。

配置密钥类信息

  1. 添加简易认证凭据。
    1. 在实例控制台的“服务集成 APIC > 凭据管理”页面,选择“凭据管理”页签。
    2. 单击凭据的名称,进入凭据详情页面。
    3. 在“AppCodes”下,单击“添加AppCode”,为凭据添加AppCode。
    4. 完成后单击“确定”。
  2. 配置自定义后端的密码和证书类型配置的值。
    1. 在实例控制台的“服务集成 APIC > 自定义后端”页面,选择“配置管理”页签。
    2. 单击配置右侧的“编辑”。
      • 密码类型配置需要修改密码的配置值。
      • 证书类型配置需要修改证书内容和私钥。
    3. 完成后单击“确定”。

修改API授权的黑白名单

仅“APP认证”类型的API支持进行授权配置。

  1. 在实例控制台的“服务集成 APIC > API列表”页面,单击API右侧的“更多 > 授权”。
  2. 在“授权历史”弹窗中,单击授权凭据右侧的“绿色通道 > 编辑”,根据实际需要修改黑白名单。
  3. 完成后单击“确定”。

创建API并发布到非RELEASE环境

  1. 在实例控制台的“服务集成 APIC > API列表”页面,单击“创建API”,根据实际需要新建API。

    具体配置过程和参数说明请参见创建API

  2. 完成后参考发布API,把API发布到环境。