API管理

使用限制

超级管理员、项目管理员、运维人员支持配置API的限流和告警。

限流设置

1. 在Dataphin首页，单击顶部菜单栏服务。

2. 按照下图指引，进入API限流配置对话框。

   

3. 在API限流配置对话框，配置参数。

   

   参数	描述
   限流状态	选择限流状态。
   单位时间	选择限流的单位，系统提供的单位时间包括：sec、min、hour、day。
   API流量限制	填写API限流的数据。例如，企业所购买的总流量为每秒查询率是500，如果单位时间选择sec，则API流量限制填写的数据应该小于等于500。
   App流量限制	填写API的下游App的流量控制。填写APP流量限制的规则： APP流量限制对API下的所有App生效。 APP流量限制必须小于等于API流量限制。 API流量限制的优先级大于APP流量限制。例如，API流量限制为每秒查询率是1000，App1的流量限制为每秒查询率是500，App2的流量限制为每秒查询率是500，App3的流量限制为每秒查询率是500，各App流量限制的总和大于API的流量限制，但流量限制的上限为API流量限制。 当APP流量限制大于API流量限制时，系统会给出报错信息。
   添加App	单击添加APP，配置应用、限流次数。填写限流次数的规则： 特殊App的限流次数必须小于等于API流量限制。 特殊App的限流次数大于API流量限制时，系统会给出报错信息。

4. 单击确定，完成API限流的配置。

   如果一个时间窗口内的请求达到限制速率，则系统通过排队、等待或降级等方式，来保护系统。

告警设置

1. 在API运维页面，按照下图指引，进入API告警页面。

   

2. 在API告警页面，配置API告警信息。

   

   参数	描述
   监控指标	选择告警规则的API监控指标。监控指标包括： 调用次数：单位时间内，调用API的总次数。 错误率：单位时间内，API调用错误总次数/API调用总次数。 平均响应时长：单位时间内，API调用总时长/API调用总次数。
   单位时间	选择API调用的单位时间。单位时间包括1min 、5min、10min、30min、60min。
   操作符	选择监控指标与触发阈值的比较的操作符。操作符包括=，>=，<=， <，>， !=。
   触发阈值	填写告警规则的触发阈值。
   通知方式	选择告警信息通知的方式。
   通知人	选择告警信息的接收人。
   静默期	在短时间内多次告警，可以设置一个静默期，在发送告警信息后的静默期期间，系统不再重复发送相同API告警规则的信息。

3. 单击确定，完成API的告警配置。

   应用调用API运行过程中，如果触发了监控告警规则，系统会给您发送告警消息，便于您及时发现并处理异常。