数据服务支持对发布的 API 进行一系列的运维操作,如 API 调用监控、报警配置、限流等操作。
本文将为您介绍数据服务 API 运维相关操作。
说明
已发布的 API,您可通过授权管理功能,将 API 对项目中已创建的应用进行授权操作,方便企业内部或外部业务应用进行调用时的权限管理操作。
API 授权操作详见“2.1 请求参数说明”中的“新增授权说明”。
新增授权完成后,您可在授权的应用列表界面中,执行以下操作:
数据服务血缘关系贯穿了数据服务 API 开发的全流程。从创建数据源信息开始,经过创建物理表、逻辑表,直至到 API 开发,最后将 API 授权给所属应用(PSM)后以供调用,上下游之间的关联关系,可借由数据服务血缘关系实现信息追溯。
例如,您可以通过血缘关系确定以下关联情况:
数据服务血缘关系为数据开发与 API 开发过程中的资源关联分析、下线决策及信息追溯提供有力支撑。
更多血缘关系的入口及操作,详见血缘关系。
已发布的 API,您可对其进行相关的报警配置。
在 API 配置界面右侧导航栏处,单击 API 详情按钮,进入查看 API 详情。
在 API 详情页单击报警配置页签,展现当前 API 配置的报警列表。
单击新增报警按钮,进入新增界面,并完成以下配置:
其中参数名称前带 * 的为必填参数,名称前未带 * 的为可选填参数。
参数 | 说明 |
---|---|
*规则名称 | 输入报警的规则名称信息。 |
*授权应用 | 您可按需将当前报警规则,绑定至所有已授权应用或指定某个应用中。 |
*报警等级 | 您可根据实际场景,设置不同的报警等级,目前支持以下几种报警等级:
|
*监控周期 | 设置每次监控的时间周期,不同报警等级,支持60s、120s、300s的监控周期。 |
*监控指标 | 下拉选择报警对应的监控指标类型,支持QPS,失败请求次数,请求失败率,PCT99,QPS/限流值几种类型。不同监控指标,可为其设置不同的报警阈值。 |
*报警接收人 | 在下拉框中选择每次报警的接收人,仅展现当前项目的成员。 |
Webhook | 支持 Webhook 方式接收报警消息,需配置能够正常请求的 post 接口, 接口请求参数会在 body 中携带以下内容:
默认支持飞书回调地址: open.larkoffice.com/open-apis/bot/v2/hook |
*接受短信 | 报警接收人需要在其用户信息中添加对应的手机电话信息方可接收短信告警。 |
*报警状态 | 此报警规则开关,您可根据实际情况,进行开启或关闭操作。 |
报警配置完成后,单击确定按钮,完成报警配置。
数据服务平台,还为您提供了几种报警模版,在报警配置页签,单击导入报警模版按钮,根据实际场景,您可勾选相应的报警模版规则,导入到当前 API 的报警配置中。
说明
请求失败率大于20%的为系统默认添加的报警规则,在 API 创建时就已经生效,报警接收人为 API 负责人,该规则通用但对高敏业务较弱,建议修改。
对已添加的报警规则,您可在操作列中,对其进行编辑、删除等操作。
已发布的API,您可查看其具体的调用监控情况。
说明
各监控指标的可查看时间范围为近 7 天,当前仅支持查看此时间段内的调用监控详情。