有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

API 详情和监控

进入数据服务 > 服务列表可查看已发布的所有服务列表,支持对服务进行下线、测试、监控、设置告警、设置可见性、服务开发、授权和删除操作。



单击 API 名称可查看 API 文档,API 详情包括基本信息、数据源信息、参数信息、调用示例和错误码。



服务列表中勾选服务,单击设置可见范围,可以使对应的 API 服务可见范围在租户、项目、私有中选择。



服务列表 > 操作 单击监控可查看当前 API 调用的情况,包括请求数、响应时间、内网出流量、有效调用次数、请求错误数的趋势。



服务列表 > 操作 单击授权可查看当前 API 授权的情况,包括用户名、授权人、授权时间、关联应用、到期时间,解除授权操作。




API 上下线

操作场景

对 API 进行下线,下线后该 API 将无法调用。

前提条件

完成 API 发布。

操作步骤

1. 登录 WeData 控制台,单击左侧项目列表选择一个项目单击服务管理进入数据服务管理页面。
2. 在服务列表找到需要下线的 API ,在操作点击下线可对当前已发布的服务进行下线,下载后 API 状态变为“已下线”,服务下线后用户将无法再调用,如需恢复可点击上线。



3. 对于已下线的 API ,可对其进行删除,删除后如需回复可在服务开发模块再次提交。

API 告警设置

操作场景

对关注的 API 进行告警设置,API 调用满足告警条件后即可触发告警,以便主动运维。

前提条件

完成 API 发布。

操作步骤

1. 登录 WeData 控制台,单击左侧项目列表选择一个项目单击服务管理进入数据服务管理页面。
2. 在服务列表找到待选 API ,在操作列单击告警设置可对选中服务进行告警设置条件,当服务调用超过设置阈值后可触发告警。






信息
详情
告警开关
是否开启告警设置,关闭后将不再触发告警
告警条件
设置服务的告警条件,当选择多个时有一个满足即可触发告警,告警指标支持调用次数和出错率。
接收人
告警条件被触发后的信息接收人
告警方式
邮件、短信、微信、语音、企业微信、Http
3. 再次点击告警设置,点击告警开关可对该 API 的告警进行取消。



API 授权和解除

操作场景

用户将自己管理的 API 授权给其他用户或解除授权,支持应用级授权。

前提条件

操作用户已经添加的 WeData 项目成员中,且是项目管理员或数据工程师角色。

操作步骤

1. 登录 WeData 控制台,单击左侧项目列表选择一个项目单击服务管理进入数据服务管理页面。
2. 进入服务开发 > 服务列表后,在操作列下单击授权对选中 API 进行授权操作。


3. 进入授权页面后,单击新增授权按钮输入授权信息。






信息
详情
授权方式
目前支持授权到个人用户
用户
支持授权租户下所有的 WeData 用户,支持多选,用户多选时关联应用仅支持选择全部。
关联应用
用户调用 API 使用的应用身份
有限期至
设置授权期限,逾期后将调用失败
4. 授权信息配置完成后,在 API 授权信息页面,单击解除授权可对用户的权限进行回收。




API 概览

进入数据服务 > API 概览可查看 API 的整体发布情况与调用趋势。包括 API 总数、已发布个数、授权用户数。调用趋势支持查看请求数、响应时间、内网出流量、有效调用次数、请求错误数的整体趋势。