检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。 API响应内容格式需要与响
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义，建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则，可保障API的高可用性。 API通道默认请求报文体长度（Body Size）限制为2MB，默认请求Header长度（Header Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
ppCode”的值），而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认证，且开启了简易认证模式，API请求既可以选择使用Key和Secret做签名和校验，也可以选择使用AppCode进行简易认证。 为了确保安全，简易
配置说明 安全认证 选择API认证方式，此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。此处勾选简易认证。 单击“下一步”，在“后端配置”页面，配置后端服务信息。 选择后端服务类型，此处选择“HTTP/HTTPS”。
生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。
服务认证：API网关代理提供AK/SK、Token等多种方式进行服务认证，只允许授权的访问。 签名密钥：API网关代理提供签名密钥，用于后端服务校验API网关代理是否合法。 访问控制 流量控制：API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。
简易认证指APP认证方式下调用API时，在HTTPS请求头部消息增加一个参数X-Apig-AppCode，而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。 注意仅支持HTTPS方式调用，不支持HTTP方式。具体使用请参考为简易认证绑定AppCode。 说明：
应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果和API网关代理传过来的Authorization头中签名是否一致，来校验API网关代理的合法性。 使用限制 同一个环境中，一个API只能被一个签名密钥绑定，一个签名密钥可以绑定多个API。 使用流程 图1 签名密钥流程图
简易认证指调用API时，在HTTPS请求头部消息增加一个参数X-Apig-AppCode（参数值填AppCode），而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。
用ECDSA和DSA加密算法。 表2 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称，根据规划自定义。建议您按照一定的命名规则填写SSL证书名称，方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件（后缀名为“
成长地图 | 华为云 API中心 API中心（API Hub）是为API开发者和应用开发者构建的，海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API，支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费，促
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
