公开与隐藏API资产

可通过隐藏API资产停止对外展示及申请使用,同时,可将隐藏的API资产进行公开。本文介绍如何公开与隐藏API资产。

前提条件

在运营模块中已为API资产编目。

背景信息

在统一服务中上线API后,系统将自动编目及公开API资产。

操作步骤

  1. 登录数据资源平台控制台

  2. 在页面左上角,单击菜单图标,选择运营

  3. 在顶部菜单栏,单击资产管理

  4. 在左侧菜单栏,选择系统资产管理 > API管理,进入API资产管理页面。

  5. (可选)

    可通过以下多种方式筛选资产,以便快速定位到目标资产。

    • 关键字:在关键字输入框,输入API名称的关键字,单击查询,展示符合该条件的资产。

    • 所属工作组:指创建资产时的对应工作组。单击所属工作组下拉列表选择对应工作组,单击查询,展示符合该条件的资产。

    • API类型:指在统一服务模块创建的API对象,单击API类型下拉列表选择对应类型API,单击查询,展示符合该条件的资产。

    • 所属类目:指资产编目或上线时指定的目录。单击所属类目下拉列表选择对应目录,单击查询,展示符合该条件的资产。

    • 创建时间:指创建资产时的起止时间。选择开始时间和结束时间后,单击查询,展示符合该条件的资产。

    • 自定义扩展属性:指在自定义扩展属性中创建的API自定义扩展属性,输入API资产对应扩展属性名称,单击查询,展示符合该条件的资产。

    说明
    • 默认展示已上线的所有API资产。

    • 如自定义扩展属性中没有创建API自定义扩展属性,或已创建,但是是否可筛选选择的是,此处不展示自定义扩展属性筛选项。

  6. 根据实际需求选择公开或隐藏API资产。

    • 隐藏API资产:选中已公开的目标API,选择批量管理 > 隐藏,或在已被公开的目标API操作列,单击隐藏

      页面提示隐藏成功,且公开状态列,对应资产显示未公开

    • 重新公开API资产:选中已被编目,且未公开(被隐藏)的目标API,选择批量管理 > 公开,或在已被编目或隐藏的目标API的操作列,单击公开

      页面提示公开成功,且公开状态列,对应资产显示已公开

后续处理

完成公开后,在发现中查看API资产详情或申请使用,具体操作,请参见查看API资产详情申请API资产