检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义，建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
本条规则是MUST类型的基本规则，可保障API的高可用性。 要求从API网关到后端服务的API调用，99%的调用响应时长<3s，TP99响应时长就是满足百分之九十九的网络请求所需要的最低耗时。 TP99响应时长达标率=TP99响应时间符合要求的API数量/总的API数量*100%，该数值应小于3s。
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
Found 无法找到对应资源，如资源不存在。 405 Method Not Allowed HTTP方法不能被用于请求相应的资源如：HTTP方法要求POST方法，请求中使用了GET方法。 406 Not Acceptable 请求资源的内容特性无法满足请求头中的条件。 413 Payload
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
申请入驻API中心服务商有哪些入口？ 申请入驻API中心服务商有以下两个入口： 进入API中心服务页面，在左侧导航栏选择“服务商入驻”，申请入驻服务商。 在API中心门户网站首页，单击页面右上角的“服务商入驻”，进入申请入驻服务商页面。 仅支持华为云企业用户申请入驻API中心服务商。
为什么要申请入驻服务商？ API中心管理控制台的以下功能只允许API中心服务商使用，如果您想要使用以下功能，需要先申请入驻成为API中心服务商： API资产管理：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
填写服务商信息。 图3 申请入驻API中心 如果您已入驻成为华为云云商店服务商，则系统会自动填充服务商信息，您不需要再次填写服务商信息，直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”，单击“立即提交”。
计费说明 API中心当前是免费的平台服务，当前API中心平台本身并不直接面向伙伴/开发者收取费用。 API商业售卖是基于华为云云商店来实现交易和变现，该场景下计费相关信息以华为云云商店相关规定为准。
API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2，推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求，您可以向系统提交工单申请更多配额。
安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。 易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。
API数据分析：查看API网关代理中已发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 前提条件 已完成华为云账号企业用户实名认证。 仅允许华为云账号入驻API中心服务商，不允许该账号下的IAM用户入驻API中心服务商。 操作步骤 进入API中心服务页面。
功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具（如华为云API Arts），进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。 华北-北京四 API资产管理 API中心服务商可在API中心管理控制台管理API资产。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
