检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
鉴权服务的路径,即服务的url。 后端超时(ms) 鉴权服务请求的超时时间。超时时间不超过后端响应超时时间上限,超时时间上限可在API网关控制台的“配置参数”中查看。 自定义host头域 仅在使用负载通道时配置。 自定义后端服务请求中的Host头域,默认使用请求中原始的host头域。
文件包含了本次查询结果的所有事件,且最多导出5000条信息。 单击按钮,可以获取到事件操作记录的最新信息。 在需要查看的事件左侧,单击展开该记录的详细信息。 在需要查看的记录右侧,单击“查看事件”,会弹出一个窗口显示该操作事件结构的详细信息。 关于事件结构的关键字段详解,请参见《
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The API does
选择API的发布环境,并填写发布说明。 单击“确定”,API发布成功后,发布按钮左上角的红色感叹号消失。 验证 使用接口测试工具调用已创建的API,或者在客户端调用已创建的API。 填写API所属分组的调试域名。 导入服务端的proto文件。 此处的proto文件如下: syntax = "proto3"; package
密钥名称 自定义名称,用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型,可选择“HMAC”和“Basic”。 Key 与“Secret”配合使用,表示签名密钥对。 HMAC:填写hmac认证所使用密钥对的Key。 Basic:填写basic认证所使用的用户名。 Secret
POST:请求方法,需替换为获取API的调用信息中获取的请求方法。 {Address}:请求地址,需替换为获取API的调用信息中获取的域名地址。 API调用场景 API请求参数配置 使用域名调用API 使用服务分配的调试域名或服务绑定的域名调用API,无需另外配置。 使用IP调用DEFAULT分组的API A
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非
通道名称 自定义VPC通道名称,用于识别不同的VPC通道。 端口 VPC通道中主机的端口号,即用户的后端业务端口号。 取值为1 ~ 65535。 成员类型 选择负载通道中的服务器成员类型。成员类型在负载通道创建后将不能修改。 实例:通过选择弹性云服务器的方式添加负载通道成员。 IP地址
在API网关控制台选择“开放API > API管理”,单击API的名称进入“调用信息”页面,可获取API的“域名”、“请求方法”和“请求路径”,以及API的基本信息。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息: 认证方式 认证信息 APP认证(签名认证)
)。 单击“导入参数”下方的“文件”,选择待导入的API文件。 支持yaml和json两种文件格式的API导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。 图3 修改全局配置
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
IP地址/域名可以是公网IP(支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址)/公网域名,前提需要开启实例的公网出口。可以是内网的IP,不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。 路径 后端服务的路径,即服务的uri,可以
云监控服务为用户的云上资源提供了立体化监控平台。通过云监控您可以全面了解云上的资源使用情况、业务的运行状况,并及时收到异常告警做出反应,保证业务顺畅运行。 APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。
力,避免重复开发造成的资源浪费。 企业能力开放 当今企业面临巨大的挑战,企业的发展需要依赖外部合作伙伴的能力,典型的例子如使用第三方平台支付、合作方账户登录等。通过API网关将企业内部服务能力以标准API的形式开放给合作伙伴,与合作伙伴共享服务和数据,达成深度合作,构建企业共赢生态。
使用APIG专享版的流量控制2.0策略实现API的精细流控操作流程 假设您对一个API有如下的流控诉求: 默认API流量限制为10次/60秒,用户流量限制为5次/60秒。 对请求头Header字段为“Host=www.abc.com”的限制为10次/60秒。 对请求方法为get且请求路径为“reqPath=
访问控制策略的名称。支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~64个字符。 类型 控制访问API的类型。 IP地址:限制调用API的IP地址。 账号名:仅适用IAM认证类型的API,限制调用API的账号名。仅支持配置账号名,对账号名及账号名下的IAM用户名做限制,不支持配置IAM用户名。
单击“确定”,生成参数header为Host对应的匹配规则“Host = www.abc.com”,表示在60s内,对于请求头中Host参数等于“www.abc.com”的API,且API调用次数达到10,参数流控生效。 根据3、4,定义参数Path对应的多重规则。 在“定义规则”区域,单击