更新时间:2022-03-18 GMT+08:00
分享

凭据管理

凭据策略用于API运行时的策略管理,支持配置APPCode、绑定凭据配额策略和绑定访问控制策略,且只有管理员(IAM用户拥有“Tenant Administrator”权限)能设置。

凭据策略分三种类型:集成凭据、订阅凭据和客户凭据(集成凭据由ROMA实例下的集成应用同步创建;订阅凭据通过订阅产品后,在产品所属实例下同步创建;客户凭据由租户管理员在APIG实例下创建)。

  • 添加AppCode

    使用APP认证方式的API,支持通过AppCode进行API调用的简易安全认证。

  • 绑定凭据配额策略

    凭据配额用于限制凭据在某个时间周期内的API调用次数,支持自定义重置时间。

  • 绑定访问控制策略

    客户端访问控制可控制访问API的客户端IP地址,保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。

  • 绑定API

    在当前凭据下绑定API,绑定后的API拥有当前凭据下的所有策略。

添加AppCode

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  3. 在左侧的导航栏选择“API管理 > 凭据管理”。
  4. 在当前应用关联的实例中,根据实际业务选择实例。
  5. 单击凭据名称,进入策略详情页面。
  6. 在“AppCode”区域,单击“添加AppCode”。
  7. 在弹窗中配置AppCode,完成后单击“确定”。

    表1 配置AppCode

    参数

    配置说明

    生成方式

    选择AppCode的生成方式。

    • 自动生成:由系统随机生成AppCode。
    • 手动输入:自定义AppCode。

    AppCode

    仅手动输入方式需要填写AppCode的值。

绑定凭据配额策略

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  3. 在左侧的导航栏选择“API管理 > 凭据管理”。
  4. 在当前应用关联的实例中,根据实际业务选择实例。
  5. 单击凭据名称,进入策略详情页面。
  6. 在“凭据配额策略”区域,单击“绑定凭据配额策略”。
  7. 在弹窗中选择已有策略或单击“创建新策略”。

    • 选择已有策略:单击“选择已有策略”后,选择策略。
    • 创建新策略:请参考表2所示配置策略。
    表2 配置凭据配额策略

    参数

    配置说明

    策略名称

    填写客户端配额策略的名称,根据规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。

    首次生效时间点

    设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08 05:05:00,则表示客户端配额策略从2020/08/08 05:05:00开始生效,每个小时的05分开始到下一个小时的05分之间为一个单位时间,即05:05:00-06:05:00为一个单位时间,以此类推。

    时长

    填写配额限制的时长,单位可选择“秒”、“分”、“时”和“天”。需与“API访问限制”配合使用,表示单位时间内客户端可调用API的总次数上限。

    API访问限制

    填写客户端可调用API的次数上限,与“时长”配合使用。

    描述

    填写客户端配额策略的描述信息。

  8. 策略配置完成后,单击“确定”。

绑定访问控制策略

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  3. 在左侧的导航栏选择“API管理 > 凭据管理”。
  4. 在当前应用关联的实例中,根据实际业务选择实例。
  5. 单击凭据名称,进入策略详情页面。
  6. 在“访问控制策略”区域,单击“绑定访问控制策略”。
  7. 在弹窗中配置策略信息。

    表3 配置访问控制策略

    参数

    配置说明

    动作

    选择访问控制的动作。

    • 允许:表示仅允许指定IP地址的客户端调用API。
    • 禁止:表示禁止指定IP地址的客户端调用API。

    IP地址

    单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。

  8. 策略配置完成后,单击“确定”。

绑定API

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  3. 在左侧的导航栏选择“API管理 > 凭据管理”。
  4. 在当前应用关联的实例中,根据实际业务选择实例。
  5. 绑定API。

    • 在凭据所在行单击“绑定API”。
    • 单击凭据名称,进入策略详情页面。单击“绑定API”。

  6. 选择授权环境、API服务和API。
  7. 单击“确定”。

相关文档