检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
配置APIG实例参数 配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 配置实例参数 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待
根据估算的QPS需求,选择购买专享版实例规格版本。规格详情请参考产品规格。 购买实例。具体操作请参考购买实例。 创建实例时,VPC建议选择后端服务器所在的VPC,可以减少网络配置的复杂度。 根据业务是否有公网访问和访问公网的需求,来确定是否开启实例的公网入口和公网出口。 申请迁移 联系技术支持工程师
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
专享版API网关 instance_id,node_ip 专享版API网关节点 instance_id,api_id API 父主题: 查看监控指标与配置告警
如果需要查看实例、实例节点的监控信息,请单击“查看更多监控”,查看更多的监控数据。 监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中,具体步骤请参见配置OBS数据存储。 查看API分组的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表参数说明,配置监控信息。 表1 监控信息 参数 配置项 带宽IP 带宽IP为实例的入口或出口IP,可在实例信息中查看。 时间段 支持查看“近1小时”、“近3小时”、“近12
配置API的HTTP响应头 配置API的Kafka日志推送 配置API的断路器 其他常用操作 配置API的发布环境和环境变量 配置API的访问控制 配置API的后端服务签名校验 配置API的自定义认证 调用API 调用APIG开放的API 配置APIG的API认证凭据 常见问题 了解更多常见问题、案例和解决方案
隐藏调试域名,且不能通过调试域名调用API。 调试域名不能用于生产业务,且仅限应用程序调试使用。 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。 创建API分组 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
String 配置项的编号 R - module_name String 配置项所属的模块名称 R - config_name String 配置项的名称 R - config_value String 配置项的值 RU - can_special Integer 是否支持特殊配置 1:
专享版-配置管理 查询某个实例的租户配置列表 查询租户实例配置列表 父主题: 专享版API(V2)
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts","enable":true
例中管理API。 专享版API网关常用于企业内部系统解耦,各服务部署在云上的VPC内,服务之间以RESTful API方式通信,通信链路在VPC内部进行,网络安全得到进一步保障。同时专享版实例支持前端或后端服务部署在公有网络,通过绑定弹性公网IP实现网络交互。 表3 共享版与专享版API网关差异
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网
/vpc-channels apig:vpcChannels:list apig:instances:get √ √ 更新VPC通道后端服务器组 PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vp
key----- CA 单向认证无需配置CA证书。 单击“确定”创建完成。 绑定域名。 在左侧导航栏选择“API管理 > API分组”。 单击API所属分组名称,进入分组详情。 在“分组信息”页签中单击“绑定独立域名”。 表2 配置独立域名 参数 配置说明 域名 填写已备案的域名。 支持最小TLS版本
API访问控制策略配置的IP地址是否为客户端的IP地址? 访问控制策略的IP地址不一定取客户端的IP地址。 APIG的访问控制是根据$remote_addr的值进行校验。$remote_addr代表客户端的IP,它的值是服务端根据客户端的IP指定的,当客户端访问APIG时,如果中
间格式:YYYYMMDDTHHMMSSZ。如果API发布到非RELEASE环境时,需要增加自定义的环境名称。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时
在函数工作流的控制台编写函数,自定义认证的代码编写指南参见创建用于前端自定义认证的函数。 根据下表参数说明,在函数工作流页面创建一个函数。 表1 函数信息配置 参数 配置说明 选择创建方式 默认“创建空白函数”。 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目 华为云的区域默认对应一