检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
本条规则是Should类型的扩展规则,可提升API的可用性。 在API的设计阶段需要对单位时间可处理的能力进行设计,指标包括吞吐量和并发量。 吞吐量(TPS)是指服务在单位时间内处理请求的数量,使用单位时间为秒。 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。 服务API的最大吞吐量
申请入驻API中心服务商有以下两个入口: 进入API中心服务页面,在左侧导航栏选择“服务商入驻”,申请入驻服务商。 在API中心门户网站首页,单击页面右上角的“服务商入驻”,进入申请入驻服务商页面。 仅支持华为云企业用户申请入驻API中心服务商。 父主题: 服务商入驻
环境变量 API网关代理提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量
生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API,Should规则在提供更全面指导的基础上,给予开发者灵活的弹性空间,方便开发者更快地加入API生态圈。
服务韧性 API中心提供了4级可靠性架构,通过全局部件跨Region容灾、Region部件跨AZ容灾、AZ内集群容灾、数据库主备容灾,保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾,当主Region异
API中心通过对接集成,为API开发者提供API Arts等自动化的API设计/开发/测试工具,开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者(API提供方)可以在API中心申请入驻为服务商,然后自助发布上架API。上架成功后,API将在API中心的API门户面向开发者公开或指定范围内开
口仍要能完成正常的功能),并提供替换方式的处理。 新版本API为兼容旧版本,增加的字段不建议作为强制填写的字段,字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 API接口的变更,要具体到参数
I接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待调试的API名称,进入“API运行”页面。
计费说明 API中心当前是免费的平台服务,当前API中心平台本身并不直接面向伙伴/开发者收取费用。 API商业售卖是基于华为云云商店来实现交易和变现,该场景下计费相关信息以华为云云商店相关规定为准。
重置Secret Key唯一且不可重置,Secret支持重置。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件
创建策略 通过策略的方式,为API提供灵活的控制策略和扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。
创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。
选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:只导出API前端定义。其中API前端定义除了Swagger规范定义项外,还包括API网关代理的一些Swagger扩展字段。