检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称,不区分大小写。
实施步骤 前提条件 已创建自定义认证函数,如果未创建请参考《函数工作流用户指南》中的创建函数章节创建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书(可选) 配置API的调用域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
创建API 操作场景 API提供者把API接口配置在API网关中,开放后端能力。 创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建A
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
创建API分组 操作场景 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。
查看APIG的调用日志 快速获取并分析实例API的调用日志。 前提条件 已调用API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日志”,将“启动日志记录”修改为,即启用日志记录能力。
修改分组自定义响应 功能介绍 修改分组自定义响应 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apps/{id}
重置密钥 功能介绍 重置指定APP的密钥。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/secret/{id} URI中的参数说明如下表所示。 表2 参数说明
功能总览 功能总览 全部 API网关 购买API网关 开放API 调用API 导入导出API 自定义认证 API SDK OBS 2.0支持 API网关 API网关(API Gateway)提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助
约束与限制 负载均衡限制 API网关专享版支持的负载均衡模式为LVS模式或ELB模式。当前仅墨西哥城一、北京一区域支持LVS模式,其他区域支持ELB模式。 配额限制 如果您需要修改默认限制值,请参考如何申请扩大配额。专享版更多参数配置,请参见配置参数。 新增或修改的APIG资源存在数据同步延迟,需要5-10秒才生效。
创建分组自定义响应 功能介绍 新增分组下自定义响应 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses 表1
实施步骤 前提条件 已创建API分组,详细操作请参见《用户指南》。 操作步骤 登录DDoS防护控制台,在左侧导航栏中选择“DDoS高防 > 概览”,单击“购买DDoS高防”。 根据业务需求,配置参数信息。详情请参考DDoS高防操作指南。 单击“立即购买”,确认产品信息无误后,单击“去支付”。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
导出APIG的API 导出JSON、YAML或YML格式的API。API网关支持单个API导出和批量API导出。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理
配置API的HTTP响应头 API响应是指API网关返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。