检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API,如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。 可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。 可能原因3:YAML文件格式问题,需要检查和修正。 可能原因4:本地proxy网络限制,更换网络环境。
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。
前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载JavaScript SDK的最新版本,并解压。在浏览器中打开demo
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击“删除”。
身份认证与访问控制 身份认证 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。
是否支持对API的请求并发次数做控制? 企业账号是否有调试域名每天最多可以访问1000次的限制? API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待删除特殊应用的流量控制策略的名称,进入流量控制详情页面。 单击“特殊应用”,进入“特殊应用”页面。
操作指导 API网关 APIG 介绍开放API的操作流程 04:34 开放API API网关 APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用API(简易认证)
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 throttle_id 是 String 流控策略的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型
授权时,“作用范围”需要选择“区域级项目”,然后在指定区域(如北京1)对应的项目(cn-north-1)中设置相关权限,并且该权限仅对此项目生效;如果在“所有项目”中设置权限,则该权限在所有区域项目中都生效。访问API网关服务时,需要先切换至授权区域。 权限根据授权精细程度分为角色和策略,策略是角色的升级版。
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
如果API未绑定流控策略,共享版API网关系统默认流控限制为200次/秒。 前提条件 需要绑定的API已发布。 创建流控策略 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击“创建流控策略”,弹出“创建流控策略”对话框。输入如表1所示信息。 表1
常告警做出反应,保证业务顺畅运行。 APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。 关于APIG支持的监控指标,以及如何创建监控告警规则等内容,请参见API监控。 父主题: 安全
VPC。 使用新的VPC和子网,请单击“控制台”,参考创建虚拟私有云章节创建待使用的新VPC和子网。 安全组 安全组用于设置端口访问规则,定义哪些端口允许被外部访问,以及允许访问外部哪些地址与端口。 例如,后端服务部署在外部网络,则需要设置相应的安全组规则,允许访问后端服务地址与API调用端口。
API的后端服务报“Backend unavailable”或“Backend timeout” API认证 APIG是否支持双向认证? 调用API提示AK/SK过期怎么处理? API策略 是否支持对API的请求并发次数做控制? API调用是否存在带宽限制 怎样给指定的用户开放API? 导入导出API 导入API失败有哪些原因?
置的x-auth-token? x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。 API网关控制台中已经限定您无法创建HEADER位置的x-auth-token,您只需在调用此API时,直接在header中增加x-auth-token和其值即可。
API认证 APIG是否支持双向认证? API签名认证的内容是否包括Body体? 调用API提示AK/SK过期怎么处理? API认证凭据问题汇总
约束与限制 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 配置终端节点信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在已创建的实例上,单击“查看控制台”或实例名称。 单击“终端节点管理”页签,根据下表参数说明,查看终端节点信息,详细信息可参考终端节点管理。
仅在协议不为“TCP”时,需要设置。 检查端口 健康检查的目标端口。 缺省时为VPC中主机的端口号。 正常阈值 判定VPC中主机正常的依据为:连续检查x成功,x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定VPC中主机异常的依据为:连续检查x失败,x为您设置的异常阈值。 取值为2
创建用户组并授权 在IAM控制台创建用户组,并授予API网关服务的权限“APIG Administrator”或“APIG FullAccess”。 创建用户并加入用户组 在IAM控制台创建用户,并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台,验证API网关服务的权限。