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

管理API产品

API产品创建完成后,在产品列表中显示新创建API产品信息,同时也支持下架、下线等操作管理API。

操作步骤

  1. 登录ROMA API控制台。
  2. 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
  3. 在左侧导航栏选择“API消费 > API产品”。

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

    相关任务

    使用场景

    操作步骤

    创建新版本

    创建产品新版本,同步产品基本信息,可自行添加API。

    1. 单击需要创建新版本的产品名称
    2. 在产品详情页面,单击“创建新版本”。
    3. 填写版本号后,单击“确定”。
    4. 在新建版本中,单击“添加API”,可添加API接口。

    编辑

    修改产品基本信息。

    1. 在API产品所在行,单击“编辑”。
    2. 修改产品信息后,单击“完成编辑”。
    3. 如果产品已上架,那么需要提交修改申请。
      1. 填写申请描述后,单击“确定”。
      2. 审核申请通过后,产品信息编辑成功。

    删除

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

    1. 在API产品所在行,单击“删除”。
    2. 确认删除产品信息后,单击“确定”。

    不推荐

    不推荐表示产品待下架。待下架的产品不推荐用户订阅,已订阅用户仍可继续使用,直到产品下架。

    1. 选择待下架的API产品,单击产品名称
    2. 选择待下架版本,单击“不推荐”。
    3. 填写不推荐申请,单击“确定”。
    4. 审核申请通过后,产品不推荐成功。

    下架

    不推荐的API产品暂停对外提供服务,可以将API产品从API目录中下架。

    1. 选择需要下架的API产品,单击产品名称
    2. 选择下架版本,单击“下架”。
    3. 填写下架申请,单击“确定”。
    4. 审核申请通过后,产品下架成功。

    克隆新版本

    创建产品新版本,同步产品基本信息和API,可自行添加API。

    1. 选择需要克隆的API产品,单击产品名称
    2. 选择克隆版本,单击“克隆新版本”。
    3. 单击“确定”,克隆完成。
    4. 在已克隆版本中可查看、添加或移除API,以及上架克隆版本。

    同步

    API服务变更后,需要手动同步信息到产品。

    1. 选择变更API服务所属产品,单击产品名称
    2. 在“版本列表”中选择同步版本。
    3. 在需要同步的API所在行,单击“同步”。

    查看API

    查看API产品下的API详情。

    1. 选择API所属产品,单击产品名称
    2. 在“版本列表”中选择版本。
    3. 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。

    移除

    API产品不需要某个API时,可将API从未上架产品中移除,即解除API与产品的绑定关系。

    1. 选择API所属产品,单击产品名称
    2. 在“版本列表”中选择版本。
    3. 选择API,单击“移除”。

相关文档