检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG共享版迁移到专享版 应用场景 APIG共享版即将退市,为了避免影响用户的业务,需要将共享版上已有资源迁移到专享版上继续使用。 约束与限制 基于APIG共享版使用了云商店功能暂不支持迁移。 基于APIG共享版使用了跨用户授权功能暂不支持迁移。 基于APIG共享版使用了ELB通道类型的VPC通道暂不支持迁移。
说明 id 是 String VPC通道的编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 vpc_instances 是 字典数据类型 后端实例列表。 表4 后端实例详情 参数 是否必选 类型 说明 instance_name 是 String 云服务器的名称。 支持汉字,英文,数字,“-”
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
后端服务部署在本地数据中心,且不能通过公网地址直接访问。 如果您使用专享版API网关,可为本地数据中心搭建一条与API网关(所绑定的华为云VPC)之间的专线。 本节针对后端服务部署在本地数据中心的场景,介绍使用API网关开放API的实践步骤。 方案架构 图1 使用云专线连通客户本地数据中心与华为云专享版API网关
绑定域名 操作场景 开放API前,您需要为API分组绑定一个或多个独立域名,API网关通过独立域名定位到此分组。 共享版中,不同分组下不能绑定相同的独立域名。 在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一
创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 单击“创建分组”,弹出“创建分组”对话框。填写如表1所示信息。
快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。 API网关支持专享版和共享版(存量用户)功能。共享版功能已下线,当前仅存量用户可以使用,共享版功能操作指导请参考共享版操作指导(仅存量用户使用),其余为专享版功能操作指导章节。 使用流程 使用API网关进行API的托管流程如下图所示。
已创建API分组和分组内的API。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。 查看API的各项监控指标。 单击“查看更多监控”,进入云监控界面,查看更多监控数据。 监控数据保留周期为两天,如果需要长时间保留
比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。 图1 签名密钥流程 创建签名密钥 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 单击“创建密钥”,弹出“创建密钥”对话框。 填写如表1所示信息。
用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期(原始指标) avg_latency
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表
前提条件 已在函数工作流服务中完成函数创建。 用户还需具备FunctionGraph Administrator角色权限。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,单击“创建自定义认证”,弹出“创建自定义认证”对话框。 填写如表1所示信息。 表1 自定义认证参数
同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。 如果API未绑定流控策略,共享版API网关系统默认流控限制为200次/秒。 前提条件 需要绑定的API已发布。 创建流控策略 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击“创建流控
进入共享版控制台 存量用户进入共享版控制台操作如下。 登录API网关控制台页面。 在“总览”页面的右上角单击“进入共享版控制台”,进入共享版页面。 父主题: 共享版操作指导(仅存量用户使用)
删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例(云服务器) 删除后端实例(云服务器) 查看后端实例列表(云服务器列表) 父主题: 共享版API(仅存量用户使用)
获取应用的AppKey和AppSecret: 在API网关共享版控制台选择“调用API > 应用管理”,在应用列表中单击API所授权应用的名称,进入应用详情页面,获取应用的AppKey和AppSecret。 获取认证签名所使用SDK: 在API网关共享版控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。