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

使用前期 #

已完成相应的API配置开发，详见“开发API”。

限流 #

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

授权管理 #

已发布的API，您可通过授权管理功能，将API对项目中已创建的应用进行授权操作，方便企业内部或外部业务应用进行调用时的权限管理操作。
API授权操作详见“请求代码说明”中的“表 新增授权 说明”。
新增授权完成后，您可在授权的应用列表界面中，执行以下操作：

• 编辑：单击操作列中的编辑按钮，对已授权的应用再次进行编辑操作，可调整其授权有效期、最大QPS等授权信息。
• 回收权限：若应用已不再需要调用该API时，您可单击操作列中的回收权限按钮，并在二次确认弹窗中单击确定按钮，将调用权限回收。

黑白名单 #

数据服务API支持您根据实际需求灵活配置黑白名单列表，可将其与授权应用管理相结合，并且添加不同的IP地址，从而实现对用户访问API的权限进行严格把控，提高数据服务API的安全性和保密性，确保API能够正常运行和数据合规使用。

• 白名单：
  在列表中的IP地址，被明确允许访问该API。只有来自该IP地址的请求才能够成功访问当前API的相关数据。
• 黑名单：
  黑名单则与白名单相反，在黑名单列表中的IP地址，被禁止访问该数据服务API，来自该IP地址的访问请求将被拒绝，其余IP地址可进行正常访问。

新增黑白名单 #

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

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

3. 单击新增黑白名单规则按钮，进入新增界面，并完成以下配置：
   

   说明

   • 在一个黑白规则内，黑名单和白名单规则只可存在一个。
   • 绑定应用为所有已授权应用的规则和绑定应用为单个应用的规则存在冲突时，以绑定为单个应用的规则优先。
     如规则A绑定了所有已授权应用, 并配置192.168.1.1/24为白名单；规则B绑定了aa.bb.cc应用, 配置192.168.1.1/28为白名单, 则应用aa.bb.cc只可在192.168.1.1/28网络内调用API。
   • 除绑定应用为所有已授权应用外, 一个应用只允许生效一个规则。
   • 如果存在调用API的应用与API服务器之间存在代理转发网络，那么黑白名单规则中，填写的IP应该为代理转发后的地址。

   其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数。

   参数	说明
   *规则名称	按需输入黑白名单规则名称信息。
   *应用名称	下拉选择允许调用API的应用名称，一个规则对应一个应用，或是所有已授权应用。 若您还未创建应用，您可单击新建应用按钮，进入系统管理 > 应用管理进行新建。操作详见“‎应用管理”。 注意 选择单个应用前，您需先完成对应的应用授权，API授权操作详见“‎请求代码说明”中的“表 新增授权 说明”。
   标志符	显示对应应用的唯一标志符。当选择所有已授权应用时，默认显示为“--”。
   *状态	按需选择黑白规则名单是否开启状态。
   *黑白名单选择	按需选择黑名单规则或白名单规则。
   *IP地址	输入黑/白名单具体的IP地址，支持设置单个IP、CIDR格式的IP段，如:192.168.0.0/24。支持粘贴多个IP地址或地址段，以英文逗号隔开。
   *描述	输入黑白名单规则的描述信息，方便后续维护管理。

4. 黑白名单信息填写完成后，单击确定按钮，完成规则配置。

管理黑白名单 #

新建完成黑白名单规则后，您可在黑白名单列表中进行以下管理操作：

• 编辑：单击列表操作列中的编辑按钮，可进入黑白名单规则窗口，对规则名称、状态、IP地址等配置项进行编辑修改操作。
• 删除：单击列表操作列中的删除按钮，可将已创建的黑白名单规则进行删除操作。

报警配置 #

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

新增报警 #

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/限流值几种类型。
   *报警接收人	在下拉框中选择每次报警的接收人，仅展现当前项目的成员。
   Webhook	支持 Webhook 方式接收报警消息，需配置能够正常请求的 post 接口, 接口请求参数会在 body 中携带以下内容: { "query_id": "12345", "alarm_id": "67890", "alarm_time_unix": 1617981372, "title": "系统警告", "content": "CPU使用率超过90%", "url": "http://example.com/alert/67890" } 默认支持飞书回调地址: open.larkoffice.com/open-apis/bot/v2/hook 地址填写完成后，您也可单击右侧测试按钮，测试报警消息是否能正常发送。
   *接受短信	报警接收人需要在其用户信息中添加对应的手机电话信息方可接收短信告警。
   *报警状态	此报警规则开关，您可根据实际情况，进行开启或关闭操作。

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

导入报警模板 #

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

报警管理 #

对已添加的报警规则，您可对其进行状态开启/关闭、编辑、查看报警记录、删除等操作。

调用监控 #

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

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