下线/删除API

操作场景

已发布的API因为其他原因需要停止对外提供服务，可以将API从相关环境中下线，相关操作请参见下线API。

• 下线后的API如果要继续使用，需要重新进行发布操作，但需注意下线API不会保留原有的授权信息。
• 下线后的API如果确认不再提供服务，可以将API删除，相关操作请参见删除API。

下线将导致此API在指定的时间无法被访问，请确保已经告知使用此API的用户。

前提条件

• 已创建API。
• API已发布到该环境。

下线API

1. 在DataArts Studio控制台首页，选择对应工作空间的“数据服务”模块，进入数据服务页面。

2. 在左侧导航栏选择服务版本（例如：专享版），进入总览页。
3. 单击“开发API > API管理”，进入到API管理信息页面。
4. 在待下线的API所在行，单击“更多 > 下线”，弹出“下线API”对话框。
5. 选择API需要下线的时间，单击“确定”，完成API定时下线。
   

   下线时间必须选择在API发布后的最低保留期限时间之后。选择下线时间后，下线操作会通知已授权用户。如果所有已授权用户均完成审核中心通知列表消息处理，或在应用中解绑与API的绑定关系，API就会直接下线；否则会以待下线状态，等待达到下线时间，再强制下线。

删除API

1. 在DataArts Studio控制台首页，选择对应工作空间的“数据服务”模块，进入数据服务页面。

2. 在左侧导航栏选择服务版本（例如：专享版），进入总览页。
3. 在左侧选择“API目录”，进入API列表页，勾选需要删除的API，单击“删除”。
   

   • 只有未发布状态（如已创建、已下线）的API可以删除，已停用或发布状态不可删除。
   • 批量删除API最多同时删除1000个API。
4. 单击“确定”，完成API删除。

相关操作

批量下线API：您可以在专享版的“开发API > API管理”页面，勾选需要下线的已发布API后，依次单击API列表上方的“批量操作 > 批量下线”，实现多个API的批量下线。

图1 批量操作