apig
基于API网关的电话号码归属地查询
更新时间:2020/10/26 GMT+08:00
简介
本手册基于华为云API网关实践所编写,用于指导您开放并调用API。
本手册主要指导您将电话号码归属地查询作为后端服务,开放一个查询API,并将此API发布到RELEASE环境,以便调用。最后将此API绑定流控策略,进行流量控制,确保API可以提供持续稳定的服务。
什么是API网关
- API网关(API Gateway)是为开发者、合作伙伴提供的高性能、高可用、高安全的API托管服务,帮助用户轻松构建、管理和部署任意规模的API。
为什么使用API网关
- 轻松构建、管理和部署任意规模的API。
- 灵活自定义的流量控制策略制定,保障API服务的稳定和连续。
- 提供多种API监控指标,更方便统计分析API服务情况。
准备环境
在通过API网关开放电话号码归属地查询服务前,您需要获取登录华为云控制台的用户名和密码,并确保已实名认证此用户。同时,您还需要获取如表1所示信息。
开放API
- 登录华为云控制台,进入API网关服务。
本实践以共享版API网关为例介绍。
- 创建分组,输入如图1所示信息。
图2 提示信息
- 创建API。
- 在“新建API”的“基本信息”界面,输入如图4所示信息。
如果您想了解参数更详细的信息,请参见《API网关 用户指南》。
图3 API列表界面 - 在“定义API请求”界面,输入如下图所示信息。
如果您想了解参数更详细的信息,请参见《API网关 用户指南》。
- 在“定义后端服务”界面,输入如下图所示信息。
如果您想了解参数更详细的信息,请参见《API网关 用户指南》。
- 在“返回结果基础定义”界面,输入如下图所示信息。
- 单击“完成”,完成API的创建。
- 在“新建API”的“基本信息”界面,输入如图4所示信息。
- 调试API。图5 API列表界面图6 调试API
- 发布API。图7 API列表界面
调用API
- 在API详情界面,复制“API URL”。图8 单击API名称进入API详情界面图9 复制API URL
- 打开浏览器,在地址栏粘贴“API URL”的地址,并且“{phoneNumber}”替换为待查询的电话号码。
请求API成功时,返回电话号码归属地信息。
对API进行流量控制
- 创建流控策略,输入如下图所示信息。
- 流控策略绑定API。
- 在浏览器中,调用API。
由于API已经绑定流控策略,如果1分钟内请求API超过5次,则会报错。
查看监控数据
- 进入API详情界面。
- 查看API请求次数、调用延时、数据流量和出错次数。
- 单击“查看更多监控”,进入云监控界面,查看更多监控数据。
监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中。
