检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中，POST请求是向指定的资源提交要被处理的数据，其响应不会被缓存；PUT请求用来提交数据时，其响应是不能被缓存的。 父主题： API生产
口仍要能完成正常的功能），并提供替换方式的处理。 新版本API为兼容旧版本，增加的字段不建议作为强制填写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
I的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。 API响应内容格式需要与响应设置媒体类型和编码格式一致。在API响应中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
API的TP99响应时长<3s 本条规则是MUST类型的基本规则，可保障API的高可用性。 要求从API网关到后端服务的API调用，99%的调用响应时长<3s，TP99响应时长就是满足百分之九十九的网络请求所需要的最低耗时。 TP99响应时长达标率=TP99响应时间符合要求的API
阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。 HTTP方法的需要符合幂等性的约束，幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用，单
API开放提供规则建议。 安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。 易用性：对API参考文档描述、入参和出参、
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节： 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节： 约束与限制 2023-05-22 第六次正式发布。 新增如下章节： 图解API中心 优化如下章节： 产品优势 2023-03-31
修订记录 发布日期 修订记录 2023-05-06 第四次正式发布。 新增如下章节： 服务商入驻成功后可以取消入驻吗？ 服务商入驻成功后信息还可以修改吗？ 2023-04-10 第三次正式发布。 优化如下章节： 为什么要申请入驻服务商？ 申请入驻API中心服务商有哪些入口？ 服务商入驻审核多久通过？
修订记录 发布日期 修订记录 2023-05-31 第七次正式发布。 优化如下章节： 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节： 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节： 生产API
修订记录 发布日期 修订记录 2023-07-14 第九次正式发布。 优化如下章节： 服务商入驻 变更服务商信息 API资产管理 2023-05-06 第八次正式发布。 新增如下章节： 取消入驻服务商 优化如下章节： 服务商入驻 变更服务商信息 负载通道 2023-03-31 第七次正式发布。
合规证书 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外，华为
附录-API治理规范指导 概述 规范要求 工具平台
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者，并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer，并将其作为API中心的API调试
调用已发布的API 调用API 响应消息头 错误码 父主题： API网关代理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
