检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。
计费说明 API中心当前是免费的平台服务,当前API中心平台本身并不直接面向伙伴/开发者收取费用。 API商业售卖是基于华为云云商店来实现交易和变现,该场景下计费相关信息以华为云云商店相关规定为准。
Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。 操作步骤 进入API中心服务页面。
网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。
认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。 基于已获取到的API调用凭
创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关代理支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。
配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在待下线的API所在行,单击“更多>下线”。
可以自定义配置AppKey和AppSecret。AppKey是身份标识,需要保证全局唯一。 如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看Key和Secret。
签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。
保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。 在对API日志
配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控:针对单个API进行流量统计和控制。 共享流控:针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。时长单位支持秒,分钟,小时,天。 与“API流量限
华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外,华为云还提供了以下销售许可证及软件著作权证书,供用户下载和参考。具体请查看合规资质证书。 图3 销售许可证&软件著作权证书 父主题: 安全
果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。
本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。 吞吐量(TPS)控制:指API单位时间内可并发处理的能力。 传输流量控制:指API单位时间内传输的数据量。
API网关注册 API搜索和查找 API订阅管理 API数据分析 服务商入驻 支持华为云企业用户申请入驻成为API中心服务商,然后使用API中心管理控制台的以下功能: API资产分享:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代
URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。 表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。
应用开发者缺少行业价值API的获取途径,不清楚哪些API可用。 API中心解决方案 API中心构建统一汇聚和展示千行百业海量API的开发者门户,为应用开发者提供统一的API搜索查找入口,并通过智能搜索和推荐,帮助开发者快速找到所需API。 API商业变现 当前面临的主要问题 API商业变现方式不够灵活。
选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API Arts工具界面。 参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择
选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API Arts工具界面。 参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择