检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
华为云 API网关 API网关(APIG)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,融合安全、负载均衡、流量入口治理、微服务流量治理、运维等多项能力,帮助企业轻松实现API安全开放、API高并发调用和入口流量、微服务流量精细化治理,简单、快速、低成本、低风险地实现内部系统集成和业务能力开放变现。
支持双重认证 仅当“安全认证”选择“APP认证”或“华为IAM认证”时可配置。 是否对API的调用进行双重安全认证。如果选择启用,则在使用APP认证或IAM认证对API请求进行安全认证时,同时使用自定义的函数API对API请求进行安全认证。 自定义认证 仅当“安全认证”选择“自定义认证”时需要配置。
为了账号安全性,建议您妥善保管并定期修改访问密钥。修改访问密钥的方法为删除旧访问密钥,然后重新生成。 企业联邦用户不能创建访问密钥,但可以创建临时访问凭证(临时AK/SK和SecuritityToken),具体内容请参见:临时访问密钥。 如果您是IAM用户,请在“安全设置>敏感
的维度限制对API的调用次数,保护后端服务。 API网关支持按分/按秒粒度级别的流量控制。 访问控制 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来允许/拒绝某个IP地址或账户访问API。 应用(凭据)
促销季、节假日等,可提前购买包年/包月资源以应对高峰期的需求,避免资源紧张。 数据安全要求高:对于对数据安全性要求较高的业务,包年/包月计费模式可确保资源的持续使用,降低因资源欠费而导致的数据安全风险。 适用计费项 以下计费项支持包年/包月。 表1 适用计费项 计费项 说明 版本(实例规格)
security_group_id 否 String 指定实例所属的安全组。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。 vpcep_service_name
{b+}。 端口 填写CCE工作负载的监测端口号。 安全认证 支持APP认证、华为IAM认证和无认证。 APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示借助IAM服务进行安全认证。 无认证:表示不需要认证。 支持跨域CORS
参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端的安全认证方式应选“自定义认证”或使用双重认证(APP认证或IAM认证)。 添加策略后端前,必须定义一个默认后端,不满足任何一个策略后端的API请求,都将转发到默认的API后端。
勾选后,当导入API扩展定义项名称(ACL,流控等)与已有的策略(ACL,流控等)名称相同时,会覆盖已有的策略(ACL,流控等)。 (可选)单击“全局配置(可选)”。 安全配置。请参考5.b。 后端请求配置。请参考1。 单击“下一步”,支持通过“表单”、“JSON”、“YAML”样式查看配置详情。 确认无误后,单击“提交”,完成配置。
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
单个用户调用API次数上限,仅适用于API的安全认证方式为APP认证或IAM认证。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 应用流量限制 单个应用调用API次数上限,仅适用于API的安全认证方式为APP认证。
API网关未能成功处理API请求,从而产生的错误响应。默认网关响应为“default”。 匹配模式 此处选择“前缀匹配”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 配置后端信息后,单击“下一步”。 表6 HTTP/HTTPS类型定义后端服务
security_group_id 是 String 指定实例所属的安全组。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。 eip_id 否 String
您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: 开放API
路径:接口请求路径。此处填写“/1234”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。 安全认证 选择API认证方式,此处选择“自定义认证”。 自定义认证 选择前提条件中已创建的自定义认证。 配置API后端 前端设置完成后,单击“下一步”,进入后端设置页面。
当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Appkey和AppSecret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode
当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成AppCode 进入API网关控制台页面。
security_group_id String 指定实例所属的安全组。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。 maintain_begin
使用APIG专享版实现gRPC服务的路由转发操作流程 创建API 创建gRPC类型的API,前后端协议均为GRPCS。 发布API 将gRPC类型的API发布到环境上。 验证 使用gRPC客户端测试gRPC服务可用性,如果服务端正常返回响应,则表示gRPC服务可用。 父主题: 使
单个用户调用API次数上限,仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。