检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约，不能单方面破坏契约。通过如下的方式来保证向后的兼容性：
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。 转义说明可参考：RFC
本条规则是MUST类型的基本规则，可保障API的高可用性。 要求从API网关到后端服务的API调用，99%的调用响应时长<3s，TP99响应时长就是满足百分之九十九的网络请求所需要的最低耗时。 TP99响应时长达标率=TP99响应时间符合要求的API数量/总的API数量*100%，该数值应小于3s。
产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中，P
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节： 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节： 约束与限制 2023-05-22 第六次正式发布。 新增如下章节： 图解API中心 优化如下章节： 产品优势 2023-03-31
原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数级别，必须将API修订的记录按照时间和版本顺序排列进行条目化，具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15
本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 标准消息头及其取值格式按照参考标准，并尽量最小化添加自定义消息头。 所有消息头命名格式一致，自定义消息头命名规范：用连词符“-”分隔单词，采用大驼峰方式如X-APIG-TOKEN。 API响应报文使用分页，避免超长列表数据返回
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外，华为云还提供了以下销售许可证及软件著作权证书，供用户下载和参考。具体请查看合规资质证书。
仅允许华为云账号取消入驻服务商，不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 在服务商入驻页面，单击“取消入驻”。
查看您在API中心门户网站中已经订阅的所有API，或对已经订阅的API单个或批量取消订阅，可以参考本章指导操作。 查看已经订阅的所有API：参考查看订阅的所有API。 对已经订阅的API单个或批量取消订阅：参考取消订阅API。 查看订阅的所有API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理”
PI调试功能模块，支持开发者在API中心直接试用API。 华为云云商店 API中心聚集API开发者和应用开发者，并汇聚技术分享和商业售卖的所有API，为云商店引流；云商店提供商业变现通道。 华为云集成工作台 API中心可以通过对接aPaaS集成工作台的集成框架，支持aPaaS集成
安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。 易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。
按API维度展示：展示所有API资产。可以在左侧勾选“分类”、“可见范围”或“API来源”，按照API资产所属行业、公开性或来源路径筛选API资产。 按服务商维度展示：展示所有API资产的服务商。可以在左侧勾选分类，按行业筛选API资产服务商。单击服务商，可以看到该服务商拥有的所有API资产。
按API维度展示：展示所有API资产。可以在左侧勾选“分类”、“可见范围”或“API来源”，按照API资产所属行业、公开性或来源路径筛选API资产。 按服务商维度展示：展示所有API资产的服务商。可以在左侧勾选分类，按行业筛选API资产服务商。单击服务商，可以看到该服务商拥有的所有API资产。
创建API分组 API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。您在创建API前，需要先创建API分组。 目前支持两种创建分组方式： 创建API分组 创建一个简单的分组，不包含API，用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件，同步创建分组。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
