检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
图1 业务使用流程 创建用户并授权使用APIG 通过IAM服务创建用户并授权使用API网关,如果系统预置的APIG权限不满足授权要求,您也可以创建自定义策略。 创建APIG实例 实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。
前提条件 在调用API前,确保您的业务系统所在网络与API的访问域名或地址互通。 如果业务系统与API网关在相同VPC内时,可直接访问API。 如果业务系统与API网关在同一区域的不同VPC内时,可通过创建VPC对等连接,将两个VPC的网络打通,实现同一区域跨VPC访问API。
表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用API网关服务的所有功能。
断路器策略是API网关在后端服务出现性能问题时保护系统的机制,支持通过熔断降级的方式保护后端服务。
用户开通云审计服务后,系统将开始记录APIG资源的操作事件,并为您保存最近7天的操作记录。CTS支持记录的APIG操作请参见云审计服务支持APIG操作列表。 图1 云审计服务 CTS的详细介绍和开通配置方法,请参见CTS快速入门。
如果您填写该参数为空,系统生成的终端节点服务的名称为{region}.{service_id}。 如果您填写该参数,系统生成的终端节点服务的名称为{region}.{vpcep_service_name}.{service_id}。
"bandwidth_size" : 5, "bandwidth_charging_mode" : "traffic", "nat_eip_ipv6_cidr" : null, "eip_ipv6_address" : null, "supported_features
如果通道类型为云容器引擎微服务,已创建集群,集群类型为CCE集群(VPC网络模型)或Turbo集群,并且已创建工作负载。 如果当前实例不支持微服务通道类型,请联系技术支持升级实例到最新版本。
创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)Key&Secret。将指定的API授权给指定应用(凭据)后,该应用(凭据)的持有者才可以调用已发布到环境中的指定API。 同一个API发布到不同的环境时,可以为之定义不同的流控策略并授权给不同的应用(凭据)。
调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。
使用场景 API网关主要涉及以下几个开发场景: API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。
访问控制 流量控制:APIG通过凭据、API、IP、用户等多维度的流控策略保护系统。 黑白名单:APIG支持系统级和API级别的IP黑白名单,拒绝恶意访问。 后端流量控制:APIG提供后端负载均衡、自动熔断等能力保护后端业务。 父主题: 安全
apig:features:list apig:instances:get √ √ 创建实例特性 POST /v2/{project_id}/apigw/instances/{instance_id}/features apig:features:create apig:instances
在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。系统自动分配的域名不能用于生产业务,且仅限应用程序调试使用。 创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。
安全水位指能够在突发流量增长至双倍的情况下,API网关系统依然维持高吞吐量和低延迟性能。
配置API的自定义认证:您可以通过自定义认证来自定义认证系统。 配置API的参数编排规则:您可以通过不同算法规则,将请求参数映射为新的请求参数。 自定义API的错误响应信息:您可以通过网关响应功能,自定义响应状态码或网关响应内容。
在“系统参数”下,单击“添加系统参数”,根据下表参数说明,添加后端服务请求的系统参数。 表8 系统参数配置 参数 说明 系统参数类型 选择系统参数的类型。 网关内置参数:支持配置的系统参数。 前端认证参数:前端自定义认证返回结果中的参数。
APIG.0613 The IAM service is currently unavailable. 503 IAM服务暂时不可用 联系技术支持 APIG.0705 Backend signature calculation failed. 500 计算后端签名失败 联系技术支持
您可以在控制台的“费用中心 > 总览”页面设置“可用额度预警”功能,当可用额度、通用代金券和现金券的总额度低于预警阈值时,系统自动发送短信和邮件提醒。 当产生欠费后,请您及时充值使可用额度大于0。
RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。