检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
paths: '/path': get: x-apigateway-cors: true 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true:支持。 false:不支持。 开启
请求方法 URI GET /v1.0/apigw/resources/outline/apis 请求消息 无 响应消息 表2 参数说明 名称 类型 说明 instance_num Integer API总个数 nums_off_release Integer 未发布到release环境的API个数
tances/{instance_id}/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id
API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 导入
符。 可见范围 当前实例:仅在当前实例下展示此证书。 全局:在当前账号和当前region的所有实例下都会展示此证书。 算法类型 选择证书所使用的加密算法类型,可选择RSA或ECC。 RSA:目前在全球应用广泛的非对称加密算法,兼容性在三种算法中最好,支持主流浏览器和全平台操作系统
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“插件策略 > 第三方认证”。 在“创建策略”弹窗中,根据下表参数说明,配置策略信息。 表1 第三方认证参数说明 参数 说明
v6协议。 如果不开启访问控制策略,默认允许所有IP访问;如果开启访问控制策略,设置“白名单”类型,但是没有配置任何IP地址,则禁止任何IP访问;如果开启访问控制策略,设置“黑名单”类型,但是没有配置任何IP地址,则允许任何IP访问。 安全组策略、实例级访问控制策略和API级访问控制策略遵循Deny优先原则。
X-Apig-Upstream-Latency 从API网关请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug,且后端服务类型不为Mock时,返回此参数 X-Apig-RateLimit-api API流量控制信息 示例:remain:9,limit:10,time:10
支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建API分组和分组内的API。 已创建环境。 发布API 进入共享版控制台。 单击“开放API >
f。 当用户使用gRPC服务时,可以通过API网关创建API,实现gRPC服务的路由转发。 约束与限制 由于GRPCS协议的约束,gRPC类型的API不支持导入、导出、调试。 父主题: 使用APIG专享版实现gRPC服务的路由转发
X-Apig-Upstream-Latency 从API网关请求后端到后端返回消息头的用时。仅在请求消息头包含X-Apig-Mode: debug,且后端服务类型不为Mock时,返回此参数。 X-Apig-RateLimit-api API流量控制信息。 示例:remain:9,limit:10,time:10
单击“创建密钥”,弹出“创建密钥”对话框。 填写如表1所示信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型,可选择“HMAC”和“Basic”。 Key 与“Secret”配合使用,表示签名密钥对。 HMAC:填写hmac认证所使用密钥对的Key。
在APIG实例中,新建API分组,并记录域名,将API添加在新建的分组中。 登录API网关控制台页面,在左侧导航栏中选择“API管理 > API分组”。 单击“创建分组 > 直接创建”,填写分组名称完成创建。 单击已创建分组名称,进入分组详情。 在“分组信息”页签中,查看调试域名并记录。该调试域名唯一
SYS.APIC 监控指标 表1 监控指标说明 指标ID 指标名称 含义 取值范围 测量对象&维度 监控周期(原始指标) requests 接口调用次数 统计测量api接口被调用的次数。 ≥0 测量对象:专享版API网关实例 测量维度:instance_id 1分钟 error_4xx
I网关实例与后端服务所在子网的通信。 如果使用VPC通道,检查VPC通道业务端口、健康检查端口、后端服务器添加是否均正常。 如果VPC通道类型为微服务,检查APIG实例是否添加路由。详细操作请参见负载通道章节。共享版APIG后端不支持配置内网ELB。 父主题: 调用API
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“插件策略 > 跨域资源共享”。 在“创建策略”弹窗中,根据下表参数说明,配置策略信息。 表1 跨域资源共享策略配置 参数 说明
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“插件策略 > Kafka日志推送”。 在“创建策略”弹窗中,根据下表参数说明,配置策略信息。 表1 Kafka日志推送参数说明
调用API报“414 Request URI too large” 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。 有关API调用的报错信息,请参考错误码。 父主题: 调用API
在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“传统策略 > 流量控制”。 在“创建策略”弹窗中,根据下表参数说明,配置策略信息。 表1 流量控制参数说明 参数 说明 策略名称 API流控策略名称。支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3-64个字符。 类型 分“基础流控”和“共享流控”两类。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。