开放API

1、创建实例

2、创建API分组

3、绑定域名

4、创建API

5、调试API

6、创建环境(可选)

7、发布API

创建API分组

1、登录API网关控制台。

2、在左侧选择已购买专享版实例。

3、在左侧导航栏选择“API管理 > API分组”。

4、单击“创建API分组 > 直接创建”。

5、单击“确定”,创建API分组。系统会同时为其分配一个调试域名,您可以用于调试API。

绑定域名

1、在“API分组”页面,单击创建API分组中分组名称,进入分组详情页面。

2、单击“分组信息”页签。

3、在“域名管理”区域,单击“绑定独立域名”,填写要绑定的域名。

创建API

创建API步骤:

1、前端配置

2、后端配置

调试API

1、在“API运行”页面的左侧选择已创建API,单击“调试”。

2、配置URL。

3、单击“调试”,下方为API发送的请求信息和API请求调用后的返回结果回显。

4、若调用成功时,状态码显示“200”。

创建环境(可选)

1、在左侧导航栏选择“API管理 > API策略”,单击“环境管理”页签。

2、单击“创建环境”,填写环境信息。

3、单击“确定”,创建环境。

发布API

1、在左侧导航栏选择“API管理 > API列表”。

2、在已创建API所在行,单击“发布”。

3、选择API需要发布到的环境。

4、单击“确定”。

API网关常见问题

API网关常见问题

  • No backend available,怎么解决?

    检查后端服务是否可以访问,如果不能访问,请修改后端服务。

    检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。

    检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子网的通信。

    若使用VPC通道,检查VPC通道业务端口、健康检查端口、后端服务器添加是否均正常。

    说明:共享版APIG后端不支持配置内网ELB


  • 后端服务调用报错域名无法解析“Backend domain name resolution failed”

    APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。

    可能原因

    APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。

    解决方法

    方法一:在创建API时,使用公网域名配置“后端服务地址”。

    方法二:在创建API时,不使用负载通道,使用用户后端服务IP配置“后端服务地址”,添加常量参数,在HEADER中添加Host:域名字段。

    方法三:在创建API时,使用负载通道。

    创建负载通道。

    添加用户后端服务地址。

    创建API时,使用负载通道,配置自定义头域。


  • 如何切换调用环境?

    默认调用“发布”环境的API。如果您要调用其他环境的API,请添加请求消息头X-Stage,参数值填写环境名称。


  • 调用请求包最大支持多少?

    共享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,API网关会拒绝该请求。这种场景,推荐考虑使用对象存储服务。

    专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。“request_body_size”表示API请求中允许携带的Body大小上限,支持修改范围1~9536 M。


  • 使用iOS系统时,如何进行APP认证?

    目前API网关为APP认证提供了Java、Python、C、PHP、Go等多种语言的SDK与demo,当您使用iOS系统(Objective-C语言)或者其他未包含在内的语言时,请参考APP认证工作原理的指导进行APP认证。


API网关相关视频

API网关

05:43

API网关

API网关

02:11

API网关

1对1咨询专属顾问

1对1免费咨询华为云专属顾问,为您量身定制产品推荐方案
立即咨询

华为云咨询电话:950808或4000-955-988 转1

华为云咨询电话:950808或4000-955-988 转1

华为云专业的服务团队,致力于为您提供专业的售前购买咨询服务,及完善的售后技术服务,助您云上无忧