检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用WAF对APIG进行安全防护 应用场景 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 方案架构 图1 后端服务器访问原理 方案优势 方案一:API分组通过域名方式对外提供服务,具备更强的可扩展性。 方案一(推荐):WAF侧注册对外访问域名并配置证书
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK
使用FunctionGraph服务实现APIG的自定义认证 应用场景 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API网关支持的自定义认证需要借助函数工作流服务实现
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/throttle-specials/{strategy_id}[?
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊
使用APIG专享版开放云容器引擎CCE工作负载实施步骤 准备CCE工作负载信息 创建集群。 登录云容器引擎控制台,在“集群管理”页面购买CCE Standard集群或CCE Turbo集群。此处选择CCE Standard集群,容器网络模型为“VPC网络”,具体操作步骤请参见购买CCE
使用APIG专享版实现gRPC服务的路由转发实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用,它基于Protobuf
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API后
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials
APIG最佳实践汇总 本文汇总了基于API网关服务(APIG,APIGateway)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎
使用APIG专享版开放本地数据中心的服务能力 应用场景 API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。 后端服务部署在公网环境中,即可以直接通过公网地址访问
快速开放并调用API 本章节将为您介绍如何快速使用API网关,这里以APP认证类型的简易认证为例,快速开放并调用API。简易认证仅支持HTTPS或GRPCS方式调用API。 图1 APIG使用流程 准备工作 在使用APIG之前,需要确保有可用的网络环境,请提前准备VPC、子网和安全组