检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
区域中获取AppCode。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 构造API请求,示例如下: POST https://{Address}/{Path}
API请求路径”后回车。 在键盘上按F12。 在“网络”页签中状态码显示“200”表示调用成功。 通过浏览器采用http协议调用API。 在浏览器的地址栏中输入“http://API请求路径”后回车。 在键盘上按F12。 在“网络”页签中状态码显示“301”表示重定向成功。 父主题:
使用WAF对APIG进行安全防护 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 图1 后端服务器访问原理 方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 推荐原因:API分组通过域名方式对外提供服务,具备更强的可扩展性。
根据下表参数信息,配置安全配置。 表4 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,配置默认后端信息。
凭据管理”。 单击凭据名称,进入凭据详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
PI参考》的“查询VPC列表”章节。 subnet_id 是 String 子网的网络ID。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询子网列表”章节。
API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。 后端服务部署在公网环境中,即可以直接通过公网地址访问。 后端服务部署在本地数据中心,且不能通过公网地址直接访问。
return json.dumps(resp) 配置测试事件并调试代码,然后部署。 在下拉框中选择“配置测试事件”并配置。 测试事件的参数值与环境变量中的参数值保持一致。 创建测试事件完成后,单击“测试”调试代码。 单击“部署”。 进入API网关控制台,在左侧导航栏选择“API管理
前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE: 后端不可用,网络不可达错误 BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API
在“自定义认证”页面,单击“创建自定义认证”。 配置自定义认证参数。 表1 自定义认证参数说明 参数 说明 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 创建前端自定义认证时,选择“前端”。 函数地址 选择用于前端自定义认证的函数后端,仅可以选择状态为“已部署”的函数后端。 版本或别名
过对等连接等方式保证网络可达。通过同一个VPC(有扩展网段等)、对等连接等方式连接网络时,需要在控制台将CCE集群详情中的“容器网段”添加到API网关实例详情中的“路由”上,否则会导致API网关到容器网络不通。 已创建的工作负载需配置Pod标签,在微服务配置时可通过Pod标签来指
0支持 购买API网关 修改子网网络信息 本小节指导您顺利购买专享版实例,实例创建完成后,才能创建API并对外提供服务。如果您对服务的性能需求不大,可使用共享版API网关,直接创建与管理API,而无需单独购买专享版实例。 删除子网 当无需使用子网、需要释放网络资源时,可删除子网。 支持区域:
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。 解决方法 方法一:在创建API时,使用公网域名配置“后端服务地址”。 方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服务IP配置“后端服务地址”,添加常量参数,在HEADER中添加Host:域名字段。
效地址,公网调用API失败。 绑定EIP后重新调用即可,详细步骤请参考网络环境准备。 入方向规则配置有误,导致公网调用API失败。 配置入方向规则的详细步骤请参考网络环境准备。 调用时未添加请求消息头“host:分组域名”,导致公网调用API失败。添加消息头后,重新调用即可。 域名问题
在“自定义认证”页面,单击“创建自定义认证”。 配置自定义认证参数。 表1 自定义认证参数说明 参数 说明 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 创建后端自定义认证时,选择“后端”。 函数地址 选择用于后端自定义认证的函数后端,仅可以选择状态为“已部署”的函数后端。 版本或别名
为什么分组跨域配置失败? 检查是否开启CORS。 进入API详情,单击“编辑”,查看是否开启CORS。如果没开启CORS,请开启。 检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。 参数配置如下: 所属分组:选择已开启CORS的API所在分组。
配置APIG实例标签 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。