检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API Arts工具界面。 参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。
建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则,给API开发者提供灵活的弹性空间。 在API设计过程中,使用POST/PUT请求来避免个人数据被缓存、记录。
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义,建议按照“动词+名词”格式。
某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。
包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API,Should规则在提供更全面指导的基础上,给予开发者灵活的弹性空间,方便开发者更快地加入API生态圈。
建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具(如华为云API Arts),进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。
“查询虚拟机列表”:GET /servers “创建VPC网络”:POST /vpc “删除虚拟机标签”:DELETE /server/tag “创建/更新数据库实例元数据”:PUT /instance/metadata API建议明确标识出版本号 本条规则是Should类型的扩展规则
新增如下章节: API数据分析 优化如下章节: 服务商入驻 API资产管理 创建API分组 发布API API工具库 2023-03-14 第五次正式发布。 优化如下章节: 使用前必读 服务商入驻 API工具库 2023-03-03 第四次正式发布。
API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。 API技术开放 当前面临的主要问题 业界海量API碎片化分布,缺少统一的汇聚平台展示API。
API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则,可保障API租户的业务连续性。 对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。
生产API:通过API工具库中提供的工具,完成API的设计、测试。 开放API: 上架API至API中心门户网站:通过创建API资产,将您开发好的API分享在API中心门户网站,供其他开发者调用。
图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称,建议按照一定的命名规则填写,方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法:接口调用方式,此处选择“GET”。
建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 所属分组 API所属的分组。可以选择已有分组,或者单击右侧的“新建分组”链接,新建一个分组。 URL 前端地址由请求方法、请求协议、子域名和路径组成。
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API Arts工具界面。 参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。
服务韧性 API中心提供了4级可靠性架构,通过全局部件跨Region容灾、Region部件跨AZ容灾、AZ内集群容灾、数据库主备容灾,保障服务的持久性与可靠性。