API 运维

数据服务支持对发布的 API 进行一系列的运维操作，如 API 调用监控、报警配置、限流等操作。
本文将为您介绍数据服务 API 运维相关操作。

1 使用前期

1. 已完成相应的 API 配置开发，详见 API 开发。

2 限流

1. 登录 DataLeap租户控制台 。
2. 在概览界面顶部服务窗口，单击数据服务按钮，可快速进入到数据服务 > API 界面。
3. 在左侧目录树中，单击已发布的 API 名称信息，便会在右侧展现出 API 的配置界面。
4. 单击右侧导航栏中的基本信息按钮，进入基本信息配置界面。
   
5. 在“最大 QPS”参数处，选择开启 QPS 限流，并自定义输入 QPS 值。

   说明

   1. 选择不限制时，则不开启 QPS 限流操作，需谨慎操作设置。
   2. 若在项目配置时，开启了“API 调大 QPS 限流审批”按钮，则在 API 基本信息中调大 QPS 限流值时，便会触发审批操作。详见项目管理。
   3. 新 API 发布时，假如 API 设置的 QPS 值超过了数据源的限流值，会触发项目管理员审批；API 发布后，编辑 API 的 QPS 值时，假如新设定的 QPS 值超过了超过了数据源的限流值，也会触发项目管理员审批。

3 报警配置

已发布的 API，您可对其进行相关的报警配置。

3.1 新增报警

1. 在 API 配置界面右侧导航栏处，单击 API 详情按钮，进入查看 API 详情。

2. 在 API 详情页单击报警配置页签，展现当前 API 配置的报警列表。

3. 单击新增报警按钮，进入新增界面，并完成以下配置：
   其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数。

   配置项	说明
   *规则名称	输入报警的规则名称信息。
   授权应用	当前默认会将报警，授权至全局的应用中。
   *报警等级	您可根据实际场景，设置不同的报警等级，目前支持以下几种报警等级： Notice：报警10分钟/次，此等级无报警升级策略。 P2：报警5分钟/次，开启报警升级选项后，若超过30分钟未处理报警，则将升级到P1报警等级。 P1：报警5分钟/次，开启报警升级选项后，若超过30分钟未处理报警，则将升级到P0报警等级。 P0：报警3分钟/次。
   *监控周期	每次监控的时间周期，根据不同报警等级，支持 60s、120s、300s 的监控周期。
   *监控指标	下拉选择报警对应的监控指标类型，支持QPS，失败请求次数，请求失败率，PCT99，QPS/限流值几种类型。
   *报警接收人	在下拉框中选择每次报警的接收人，仅展现当前项目的成员。
   *报警状态	此报警规则开关，您可根据实际情况，进行开启或关闭操作。

4. 报警配置完成后，单击确定按钮，完成报警配置。

3.2 导入报警模版

数据服务平台，还为您提供了几种报警模版，在报警配置页签，单击导入报警模版按钮，根据实际场景，您可勾选相应的报警模版规则，导入到当前 API 的报警配置中。

3.3 报警管理

对已添加的报警规则，您可在操作列中，对其进行编辑、查看报警记录、删除等操作。

4 调用监控

已发布的API，您可查看其具体的调用监控情况。

1. 在 API 详情页单击调用监控页签，展现当前 API 的调用监控详情。
2. 您可在界面授权应用处，下拉选择API已授权的应用，可根据不同应用，区分监控详情。
3. 目前为您展现以下几种监控指标信息，您可以根据右上角的时间范围选择进行查看：
   • QPS：每秒的请求次数
   • 请求成功率：该时间段的请求成功率
   • PCT99: 99%请求所消耗时间(ms)的范围
   • 99%请求所消耗的时间(ms)范围
4. 您可根据实际情况，查看测试或线上环境中的调用监控情况，自定义选择查看的时间范围和时区等信息。