全部产品

API 授权对象

更新时间:2020-07-15 14:22:08

只用通过授权的订阅方应用可以调用 API。在 API 详情页的 授权对象 标签页下,您可以绑定授权对象、解除绑定以及限制应用访问 API 的次数。

绑定授权对象

操作步骤如下:

  1. 进入 API 发布 > API 管理 页面,找到待授权的 API,点击进入其详情页。
  2. 授权对象 标签页下,点击 绑定授权对象,进入 添加授权应用 窗口。
    • 对于已添加为授权对象的订阅方应用,您可以直接在授权对象列表中搜索找到。
    • 对于暂未添加为授权对象的订阅方应用,您需要先为该应用创建一个授权对象。详见 创建授权对象
      绑定授权对象
  3. 在授权对象的列表中,选择待授权对象,点击 确定,完成绑定。

解除绑定

在 API 详情页 > 授权对象 标签页下,找到需要解除绑定的授权对象,点击其 操作 列的 解除绑定 按钮,并确定即可。

解除绑定

限流配置

您可以对 API 绑定的应用进行限流,即指定每秒该应用对该 API 可访问的次数。

  1. 在 API 详情页 > 授权对象 标签页下,找到需要限流的授权对象,点击其 操作 列的 限流配置 按钮。
  2. 在新窗口中,进行限流配置后,点击 确定
    • 限流开关:将其状态设置为
    • 限流阈值:必填,即每秒该应用对该 API 可访问的次数,只能输入大于 0 的正整数。
    • 异常响应类型:必选,支持 返回数据网关响应码返回
      限流配置