检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。
x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。
在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。
API网关代理支持单个API导出和批量API导出。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 在APIG实例中,新建API分组,并记录域名,将API添加在新建的分组中。 登录API网关控制台页面,在左侧导航栏中选择“API管理 > API分组”。
API列表 创建API 导入API 导出API 发布API 授权API 调试API 下线API 开启跨域访问 父主题: API网关代理
OpenAPI接口 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 共享版API(仅存量用户使用)
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。
使用FunctionGraph服务实现APIG的自定义认证 应用场景 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
共享版API网关 共享版API网关按调用量费用+公网流量费用计费,调用量指API调用次数,流量指API调用的下行网络流量。计费模式详情请参考表3。 共享版APIG已下线,当前仅存量用户可以使用。关于计费模式详情请参考价格详情,下文不再具体描述。
简易认证指APP认证方式下调用API时,在HTTPS请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。
父主题: 管理APIG实例
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。
使用APIG专享版开放本地数据中心的服务能力 应用场景 API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。
适用于API网关(APIG)的最佳实践 该示例模板中对应的合规规则的说明如下表所示: 表1 合规包示例模板说明 合规规则 规则中文名称 涉及云服务 规则描述 apig-instances-authorization-type-configured APIG专享版实例配置安全认证类型
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域。
您可以自定义入端口,相关操作请参考自定义APIG的客户端访问端口。不使用HTTP端口,选择“禁止”即可。 HTTPS端口 默认值“443”,HTTPS协议的默认端口。您可以自定义入端口,相关操作请参考自定义APIG的客户端访问端口。不使用HTTPS端口,选择“禁止”即可。
图1 通过API网关代理访问负载通道中的ECS 前提条件 API网关代理与负载通道中的服务器之间网络互通。 创建负载通道 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“负载通道”页签,进入到负载通道列表页面。