检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关(API Gateway)提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API,并上架API市场进行售卖。借助API网关,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。
策略后端有多个时,怎么匹配和执行 当您的API配置了多个策略后端,API网关会按顺序进行匹配,匹配到其中一个立即执行API请求转发,不会进行后续的匹配。 当策略后端都没有匹配成功,则按照默认后端执行API请求的转发。 父主题: API调用
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}
对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: API创建
您可以根据以下操作流程为API创建并绑定流量控制2.0策略。 创建策略 填写流量控制2.0策略基本信息。 配置基础流控 配置基础流量控制。 配置参数流控 开启参数流控配置开关,定义参数和规则配置参数流量控制。 配置特殊流控 开启特殊流控配置开关,特殊凭据与特殊租户流量控制的使用场景。 绑定API 流量控制2.0策略绑定到API。
Array of ThrottleSpecialInfo objects 本次查询返回的特殊配置列表 表5 ThrottleSpecialInfo 参数 参数类型 描述 id String 特殊配置的编号 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制
当API的请求协议为GRPC类型时不支持配置。 result_failure_sample 否 String 失败返回示例,描述API的异常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
考调用API调用。 前提条件 使用前,请先了解前提条件。 配置参数说明 表1 配置参数说明 参数 说明 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时,配置鉴权服务的负载通道。 选择“不使用”时,配置鉴权服务的访问地址。 后端URL 请求方法 支持GET、POST、PUT、HEAD请求方法。
删除签名密钥 功能介绍 删除指定的签名密钥,删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}
降级参数配置 降级参数配置开关。开启后可为断路器自定义规则,API请求优先匹配自定义规则中的触发条件和降级策略,仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。 如果匹配到自定义规则,则执行规则内配置的触发条件和降级策略。如果匹配到的自定义规则内未配置触发条件或
http时必选 enable_client_ssl 否 Boolean 是否开启双向认证。如果开启,则使用实例配置中的backend_client_certificate配置项的证书 缺省值:false status 否 Integer 健康检查状态 1:可用 2:不可用 timeout
throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4 throttle_specials参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String
of strings 可用区列表。 可用区指在同一地域下,电力、网络隔离的物理区域,可用区之内内网互通,不同可用区之间物理隔离。选择多个AZ部署可以有效提升可靠性。 获取方法:通过文档中实例管理的可用区列表接口查询。 bandwidth_size 否 Integer 出公网带宽 实
第三方认证策略:通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。 响应缓存策略:将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 不同的策略类型,策略内容的配置不同:
API绑定Kafka日志推送策略后,性能将损耗30%。 日志支持最大推送大小为4K,请求体/响应体支持最大推送大小为1K,超出部分会被截断。 配置参数说明 表1 配置参数 参数 配置说明 策略基本信息 Broker地址 填写目标Kafka的连接地址,建立连接关系。多个地址间以英文逗号(,)隔开。 Topic主题
支持,如需使用,请联系客服。 配置参数说明 表1 配置参数说明 参数 说明 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:限制调用API的IP地址。 账号名:仅适用IAM认证类型的API,限制调用API的账号名。仅支持配置账号名,对账号名及账号名下的IA
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。例如“API01”。 所属分组 默认“DEFAULT”。
导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。 图3 修改全局配置 图4 修改接口配置 单击“快速上线”,完成API导入。 导入的API不会自动发布到环境,需要您手动发布。
根据下表参数信息,配置安全配置。 表4 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,配置默认后端信息。