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

管理API

API创建完成后,在API列表中显示新建API,同时也支持编辑、授权、下线等操作管理API。

管理API

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  3. 在左侧导航栏选择“API管理 > API服务”。
  4. 在当前应用关联的实例中,根据实际业务选择实例。
  5. 在页面上单击服务名称,进入API服务详情页面。
  6. 单击“API运行”页签。

    根据下表相关任务,了解如何管理API。
    表1 管理API

    相关任务

    使用场景

    操作步骤

    编辑API

    修改API信息。

    1. 选择需要编辑的API。
    2. 单击“编辑”,修改API信息,具体操作请参考创建API

    授权API

    仅使用APP认证方式的API,才需要授权,发布API后,通过指定授权给某些应用,让指定应用能够调用API。

    1. 选择需要授权的API。
    2. 选择“更多 > 授权”。
    3. 在弹窗中设置授权信息。
      1. 选择授权应用。
      2. 设置访问参数。
      3. 选择是否开启绿色通道。
      说明:
      • 仅能授权自己有权限的应用。
      • 访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。
      • 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。
    4. 单击“确定”,完成授权。

    下线API

    已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。

    1. 选择需要下线的API。
    2. 单击“下线”,选择需要下线的环境。
    3. 单击“确定”,完成下线。

    删除API

    API不再提供服务且已下线,可以将API删除。

    1. 选择需要删除的API。
    2. 选择“更多 > 删除”。

    发布历史

    查看API发布的历史记录。

    1. 选择需要查看的API。
    2. 选择“更多 > 发布历史”。

    批量操作

    批量发布、下线或删除API。

    单击“批量操作”,勾选需要批量操作的API。

    • 发布,请单击
    • 下线,请单击
    • 删除,请单击

分享:

    相关文档

    相关产品